어떻게 구축은 좋은(web)API

https://stackoverflow.com/questions/33728

api-design

09-06-2019
|

문제

나를 구축하기 위한 API 를 웹 응용 프로그램에 관심이 있어요 어떤 사람을 제안할 수 있으로 안 좋은 사례입니다.

나는 이미 계획하고 그것은 버전을 지정(버전 1 수의 특정 측면을 제어 시스템,버전 2 통제할 수 있는 더 이상이 필요할 수 있습에서 변경 방법은 인증을 수행하는 것으로 호환되지 않는 버전 1),그리고 인증을 별개의 것이 표준 사용자명/암호를 사용하여 로그인(는 경우에는 사용자가 사용하여 악의적인 도구 그것이 열리지 않습니다 그들에게까지 전체 가장,다만 어떤 api)를 보낼 수 있습니다.

누군가에 추가로 아이디어를,또는 사이트의 예로 특히 좋은 Api 당신이 사용됩니까?

해결책

읽 편안한 웹 서비스 예약,당신을 제공하는 좋은 사용하는 방법에 대한 개요를 나머지 부분에서 연습을 얻을 최대 속도로 충분히 빠르게 시작으로,지금 일부는 신뢰입니다.이보다 더 유용하고 기존 API,기 때문에 그것에 대해서도 설명합 설계 선택 및 trade-offs.

다른 팁

1)굽는 버전 번호를 직접적으로 URL 보다는 전달하는 매개변수로,그 이후 당신에게 완전한 자유를 변경하는 조직의 API 네임스페이스의 각 버전을 뺍니다.

2)유의 URL 재작성 규칙을(있다면)으로 간단한/경사로 가능한(하지만 더 간단한)하는 동안,당신의 Url 을 가능한 아름다운(지만 더 이상).

3)항상 최 HTTP 상태 코드를 찾을 수 있습니다 각각의 응답(에 대해 잊지 마세요 202 및 207,예를 들어).

4)를 구현하는 파시스트 매개 변수는 유효성 검사 논리,그리고 유익한 오류 메시지를 가지고 있습니다.

5)HTTP 요청 헤더를 적절한 대신의 매개변수(다음과 같 받아들이는,예를 들어,클라이언트를 지정하여 원하는 데이터 형식의 응답).

6)구성하는"명사에서"그런 방법으로 사용하는 Url 에 의해 서로 다른 클라이언트 대상을 분리 근처에는"루트의"URL tree(이것은 쉽게 적용하는 다양한 인증에 대한 메커니즘 사람들 서로 다른 고객 필요한 경우,또는 지도 다른 부분의 URL 트리는 서로 다른 서버).

7)게재하는 경우 일반 웹 페이지 동일한 도메인으로 귀하의 Api 를 사용하여 동일한 인증이 필요 X 요청-을 가진 헤더에서 당신의 API 를 요청을 피하기 위하여 xsrf vulnerabiities.

나는 살펴 검증된 Api 를:

의 많은 인수 여부에 대해 이러한 Api 를 사용하여"좋은"그러나 내가 생각한 그들의 성공을 입증하고 그들은 모두 사용하기 쉽습니다.

사 나머지.

편안한 웹 서비스 아키텍처 구현하기 쉽고 사용하는 장점과 의미의 HTTP 위해 무엇도록 설계되었습니다.그것은 리소스가 지향적처럼,자체 웹.

아마존 웹 서비스, Google 고 많은 다른 사람 제공합 REST Api 와 상호 작용하는 그들의 제품입니다.

사용다.

에 읽 표준에 대한 Api,또는 복사에서 아이디어를 하나의 인기있는 것들입니다.

주의할 때 사용자를 인증합니다.

시작은 매우 매우 간단합니다.

사이트 구축을 사용하는 API(의 경우에도 유용하지 않)을 확인하는 것입니다.아마도 당신의 모바일 버전 사이트 또는 무언가를 당신을 API 를 사용하여 많은면에서의 깊이가 있습니다.

라이센스 : CC-BY-SA ~와 함께 속성

제휴하지 않습니다 StackOverflow