«api-design» 태그된 질문

API (Application Programming Interface) 디자인에서는 범용 또는 공용으로 사용되는 라이브러리를 만들기위한 모범 사례에 대해 설명합니다.

5
REST API는 명령 / 작업 기반 도메인에 어떻게 적합합니까?
이 기사 에서 저자는 때로는 본질적으로 RESTful하지 않은 작업을 API에 노출해야하는 경우가 있습니다. 그리고 API에 작업이 너무 많으면 RESTful 원칙을 사용하지 않고 RPC 관점으로 설계되었거나 해당 API가 자연스럽게 RPC 유형 모델에 더 적합하다는 것을 나타냅니다. 이것은 내가 읽고 다른 곳에서들은 것을 반영합니다. 그러나 나는 이것이 매우 혼란스럽고 문제에 대해 더 …

5
REST API에서 양방향 동기화를 가장 잘 표현하는 방법은 무엇입니까?
리소스가있는 웹 응용 프로그램이 있고 다른 유사한 리소스가있는 원격 응용 프로그램에 대한 참조가있는 시스템을 가정하면 '로컬'리소스를 '원격'리소스와 동기화하는 양방향 동기화 작업을 어떻게 표현합니까? 예: 할 일 목록을 나타내는 API가 있습니다. GET / POST / PUT / DELETE / todos / 등 해당 API는 원격 TODO 서비스를 참조 할 수 있습니다. …

2
REST API에서 컬렉션에 기존 항목을 추가하는 가장 좋은 패턴은 무엇입니까?
실용적인 REST API를 디자인하고 있으며 기존 엔터티를 컬렉션에 추가하는 가장 좋은 방법을 고집했습니다. 내 도메인 모델에는 사이트 모음이있는 프로젝트가 포함되어 있습니다. 이것은 엄밀한 다 대다 관계이며 관계를 명시 적으로 모델링하는 엔티티 (예 : ProjectSite)를 만들 필요가 없습니다. 내 API를 통해 소비자는 기존 사이트를 프로젝트에 추가 할 수 있습니다. 내가 끊어지고있는 …
23 rest  api-design 

5
성공할 때 true / false 대 void를 반환하고 실패 할 때 예외를 던지는 함수
파일을 업로드하는 함수 인 API를 만들고 있습니다. 이 함수는 파일이 올바로 업로드 된 경우 아무 것도 반환하지 않고 문제가 발생하면 예외를 발생시킵니다. 왜 거짓이 아닌 예외입니까? 예외 내에서 실패 이유 (연결 없음, 파일 이름 누락, 잘못된 암호, 파일 설명 누락 등)를 지정할 수 있습니다. API 사용자가 모든 오류를 처리하는 데 …

2
코드를 보면 API가 무엇을하고 있는지 항상 알아야합니까?
최근에 저는 자체 API를 개발하고 있으며 API 디자인에 대한 관심을 바탕으로 API 디자인을 개선 할 수있는 방법에 관심이있었습니다. 몇 번 등장한 한 가지 측면은 (API 사용자가 아니라 주제에 대한 관찰 토론에서) : API를 호출하는 코드를보고 수행하는 작업을 확인하는 것만으로도 알 수 있습니다 . 예를 들어 담론 리포지토리에 대한 GitHub에 대한 …


4
Java 콜렉션 API에 마지막 방법이없는 이유는 무엇입니까? [닫은]
휴무 . 이 질문은 의견 기반 입니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 사실과 인용으로 답변 할 수 있도록 질문을 업데이트하십시오 . 휴일 오년 전에 . 이것은 java.util.List와 같은 정렬 된 컬렉션을위한 것입니다. 언어 디자이너가 왜 마지막 방법을 포함하지 않았습니까? 내가 생각할 수있는 유일한 …
19 java  api-design 

2
REST API 디자인 : API에 대한 다중 호출 및 단일 호출
모바일 앱에서 사용할 전자 상거래 웹 사이트 용 Rest API를 개발 중입니다. 앱의 홈 페이지에서 Slider, Top Brands, Best Selling Products, Trending Products 등과 같은 여러 리소스를 호출해야합니다. API 호출을위한 두 가지 옵션 : 단일 통화 : www.example.com/api/GetAllInHome 여러 통화 : www.example.com/api/GetSliders www.example.com/api/GetTopBrands www.example.com/api/GetBestSellingProducts www.example.com/api/GetTrendingProducts 휴식 API 디자인에 대한 가장 …
19 rest  api  api-design  url 

4
데이터베이스 추상화-과장되고 있습니까?
수많은 데이터베이스 추상화 계층에 노출 된 후 데이터에 액세스하기위한 자체 패러다임을 개발하는 모든 라이브러리의 요점이 무엇인지 궁금해졌습니다. 새로운 DAL을 선택하면 새로운 언어를 다시 배우는 것처럼 느껴집니다. 일반적으로 내가 원하는 것은 레이어가 이미 내 머리에 쓴 SQL 쿼리를 출력하도록 설득하는 것입니다. 그리고 그것은 사실 후에 가독성에 영향을 미치지 않습니다. # Exhibit …
18 database  sql  api-design  dsl 

4
Java String에 정적 문자열 조작 방법이없는 이유는 무엇입니까?
Java 디자이너 가 java.lang.String클래스 에서 정적 버전의 문자열 조작 메소드를 작성 하지 않은 이유는 무엇 입니까? 다음 메소드는 내가 참조하는 것이지만 클래스의 다른 비 정적 메소드로도 질문을 확장 할 수 있습니다. concat(String) substring(int, int) replace(char, char) toLowerCase() replace(CharSequence, CharSequence) toLowerCase(Locale) replaceAll(String, String) toString() replaceFirst(String, String) toUpperCase() split(String) toUpperCase(Locale) split(String, int) …
17 java  api-design  null 

3
IEnumerable "상태 머신"감지
C # yield return으로 너무 귀여워지기 라는 흥미로운 기사를 읽었습니다. IEnumerable이 실제 열거 가능한 컬렉션인지 또는 yield 키워드로 생성 된 상태 머신인지 감지하는 가장 좋은 방법은 무엇인지 궁금합니다. 예를 들어 기사에서 DoubleXValue를 다음과 같이 수정할 수 있습니다. private void DoubleXValue(IEnumerable<Point> points) { if(points is List<Point>) foreach (var point in points) …
17 c#  api-design 

3
인터페이스에서 언제 string_view를 사용해야합니까?
나는 모방 A와 디자인 된 내부 라이브러리를 사용하고 C ++ 라이브러리를 제안 하고, 언젠가 지난 몇 년 동안 나는 볼의 인터페이스를 사용하여 변경 std::string에를 string_view. 그래서 새로운 인터페이스에 맞게 코드를 정중하게 변경했습니다. 불행히도, 전달해야 할 것은 std :: string 매개 변수이며 std :: string 반환 값입니다. 그래서 내 코드는 다음과 …

2
RESTful API에서 중첩 자원을 사용하는 경우
사용자와 링크라는 두 가지 리소스가 있습니다. 사용자는 그들과 관련된 여러 링크를 가질 수 있습니다. 다음 URI에서 사용자와 연결된 링크에 도달 할 수 있도록 RESTful API를 설계했습니다. /users/:id/links 그러나 항상 링크에 대한 URI가 필요합니다. 때로는 사용자에 관계없이 모든 링크를 원할 수도 있습니다. 이를 위해 나는 가지고있다 : /links 괜찮습니까? 링크에 대한 …
16 api  rest  api-design 

3
버전 관리 REST API. 각 API에는 자체 버전이 있습니다
URL에서, 특히 경로의 시작 부분에 다음과 같은 REST API 버전을 지정하는 것이 매우 일반적입니다. POST /api/v1/accounts GET /api/v1/accounts/details 그러나 버전이 각 API와 관련된 디자인은 보지 못했습니다. 즉, 각 API의 버전을 별도로 유지 관리합니다. 즉 : POST /api/accounts/v2 GET /api/accounts/details/v3 이 접근 방식을 사용하면 변경이 필요할 때 특정 API의 API 버전을 …

1
RESTful API 및 i18n : 응답 디자인 방법
우리는 주로 단일 클라이언트의 요구를 충족시키기위한 RESTful API를 설계하고 있습니다. 매우 특정한 상황으로 인해이 클라이언트는 가능한 적은 요청을해야합니다. API는 요청의 Accept-Language 헤더를 통해 i18n을 처리합니다. 이는 클라이언트가 사용 가능한 모든 로케일에서 단일 엔드 포인트에 대한 요청 응답을 저장해야하는 하나의 기능을 제외하고 클라이언트가 수행해야하는 모든 작업에 적용됩니다. 클라이언트가 일관되고 체계적인 RESTful …
15 rest  api  api-design  http 

당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.