어떻게 좋은 API 인터페이스를 개발하고 설계할 수 있습니까?
지우기 기능
디자인 초기에는 API 의 자세한 기능을 분류하고 비즈니스 기능 포인트 또는 모듈별로 분류하여 API 에서 제공해야 할 기능을 명확히 해야 합니다.
코드 논리가 매우 명확하다
코드를 깔끔하게 유지하고 필요한 주석을 추가하여 인터페이스 기능이 단일한지 확인합니다. 인터페이스에 복잡한 비즈니스 논리가 필요한 경우 여러 인터페이스로 분할하거나 기능을 공용 메서드로 별도로 패키징하여 인터페이스에 코드가 너무 많지 않도록 하는 것이 좋습니다. 사후 유지 관리 및 사후 반복에는 도움이 되지 않습니다.
필요한 안전 검사 메커니즘
현재 웹 애플리케이션은 데이터 도용, 변조, 불법 제출, 중복 요청 등의 보안 문제가 발생하기 쉬우므로 API 의 보안 인증 메커니즘이 필수적입니다. 일반적인 솔루션은 디지털 서명의 형태로 각 HTTP 요청에 서명을 추가하고 서버측에서 서명의 합법성을 확인하며 요청의 합법성을 보장하는 것입니다.
항해 일지 기록
제때에 문제를 찾기 위해서는 일지가 필수적이다.
커플링을 줄입니다
좋은 API 는 가능한 한 간단해야 한다. API 간의 비즈니스 결합이 너무 높으면 코드 예외로 인해 관련 API 를 사용할 수 없게 되므로 API 간의 복잡한 호출 관계를 최소화할 수 있습니다.
의미 있는 상태 코드를 반환합니다
API 에서 반환된 데이터는 상태 코드 데이터를 휴대해야 합니다. 예를 들어 200 은 일반 요청이고 500 은 내부 서버 오류입니다. 공용 상태 코드를 반환하면 문제 포지셔닝에 도움이 됩니다. 예를 들어, 다음 상태 코드를 참조할 수 있습니다.
개발 문서
API 는 제 3 자 또는 내부용으로 제공되기 때문에 문서를 개발하는 것이 필수적입니다. 그렇지 않으면 다른 사람이 호출하는 방법을 알 수 없습니다. 좋은 API 개발 문서에는 다음 요소가 포함되어야 합니다.
1, 현재 API 아키텍처 모델 설명, 개발 도구 및 버전, 시스템 게으름 등 환경 정보
2. 현재 API 는 어떤 기능을 제공합니까?
3.API 모듈 간의 불활성 관계;
4. 통화 규칙 및주의 사항;
5, 배포 고려 사항 등.
좋은 API 는 사용하기 쉽고, 이해하기 쉽고, 쉽게 확장되고, 오용하기 쉽고, 보안이 높고, 강력해야 한다. 이 몇 가지를 하는 것은 쉽지 않지만, 위의 원칙에 따라 업무 자체의 합리적인 구분에 따라 API 를 설계해야 한다.