1. 사양 개발
개발 전에 데이터가 반환하는 일반 매개 변수 및 형식과 같은 사양을 개발해야 합니다. Xml 과 JSON 은 데이터 형식에 대해 널리 사용되고 있습니다. Json 은 XML 보다 더 많은 이점이 있기 때문에 JSON 을 사용하는 것이 좋습니다.
2. 단순화된 반환 데이터
인터페이스 데이터는 사용자 잔액 조회 및 등록 시간과 같은 반환에 필요한 원칙에 부합하기 때문에 웹 페이지의 방법은 select * from user where 일 수 있습니다.
Uid= 1 이지만 인터페이스는 사용자 where 에서 balance 와 regtime 을 선택해야 합니다.
Uid= 1. 인터페이스에서 데이터를 반환하는 것은 오버헤드와 트래픽이 있기 때문에 가능한 한 적은 데이터를 반환하여 성능을 크게 향상시킬 수 있습니다.
3. 데이터 유형은 엄격해야 합니다
데이터 유형을 확인합니다. App 클라이언트가 개발한 Java 및 object-c 언어는 데이터 유형에 대한 요구 사항이 엄격하므로 정수 데이터를 int 로 변환해야 합니다. 유형이 올바르지 않으면 app 로 다시 깜박입니다.
4. 인터페이스 문서 작성
반드시 인터페이스 문서를 쓰고, 모듈별로 쓰고, 사양을 써야 한다. 최적의 형식은 다음과 같습니다.
인터페이스 요청 주소 요청 매개 변수 (매개 변수 이름, 유형 및 필요 여부 포함); 테스트 매개 변수의 예 매개 변수 (각 매개 변수의 의미를 나타내는 매개 변수 이름) 를 반환합니다.
이렇게 하면 앞으로 프로젝트가 크더라도 유지 관리가 어려운 문제가 되지 않을 것이다.
5. 코드가 정확한지 확인합니다
코드가 올바른지 확인하고, 생성 환경에서 오류를 마스킹하고, 헤더에 추가 출력을 피하고, 반환된 JSON 을 구문 분석하는 등의 데이터 실패로 인해 app 플래시백이 발생합니다.
6. 코드 성능을 최적화하기 위해
App 는 사용자에게 더 나은 경험을 제공하기 위해 빠른 응답을 요구합니다. 따라서 비즈니스 논리를 처리할 때 모바일 인터페이스는 너무 복잡한 SQL 문을 실행하거나 많은 루프를 포함하지 않도록 해야 합니다. 예를 들어 첫 페이지의 열 모듈 정보를 redis 캐시에 저장할 수 있습니다. 네트워크 속도에 관계없이 이상적인 인터페이스 응답 시간은 200ms 이내여야 합니다.
7. 기존 인터페이스를 임의로 변경하지 마십시오
앱은 웹페이지와 다르다. App 가 게시되면 누군가가 사용한 후에는 인터페이스를 수정하지 마십시오. 향후 업그레이드도 마찬가지다. 수정은 인터페이스의 원래 구조 이상으로 확장해야 합니다. 그렇지 않으면 이전 인터페이스를 호출하는 app 에 버그가 발생합니다.
8. 인터페이스 보안에주의하십시오.
안전은 무엇보다 중요하므로 인터페이스의 안전을 보장해야 한다. 전화번호 등 민감한 정보는 전송 과정에서 암호화해야 합니다. 그렇지 않으면 다른 사람에게 캡처될 수 있습니다. 사용자 정보를 가져오는 인터페이스는 권한을 검증해야 하며, 인터페이스가 악의적으로 호출되는 것을 방지하고, 사용자 정보를 누설하거나, 심지어 정보를 변조하는 것을 방지해야 한다.