좋은 API

API를 여러 개 작성해보고, 다른 사람들이 작성한 API도 살펴보고 느낀 것에 대해서 적어보려고 한다.

API를 처음 작성할 때에는 무조건 돌아가기만 하면 된다고 생각하고 작성했던 것 같다. 그러나 그 이후에 API에 대해서 더 배우고 나서는 돌아가기만 하면 된다가 아니라 조금이라도 더 완성도 높은 API를 작성하려고 하게 된 것 같다.

그렇다면 완성도 높은 API는 무엇일까?

• 가장 기본적으로 REST API의 원칙을 잘 지켜서 작성한 URI
• 어떤 값이 입력 되어도 그 값에 유효하게 잘 작성된 Validation
• 논리적인 검증
• 등록된 유저의 API라면 jwt 적용
• 여러 개의 쿼리가 사용된다면 Transaction 반드시 적용
• Query string, Path variable의 적절한 사용
• 올바른 DB 사용
• 불러올 데이터가 많다면 Paging 적용
• SQL Injection 주의

물론 위의 사항들 외에도 더 있겠지만 본인이 지금까지 API를 작성하고 배우면서 느낀 좋은 API의 요구사항이라고 생각한다.

급한 마음 보다는 꼼꼼하게 보자는 마음으로 API를 작성하고, 두번 이상 확인 하는 것도 중요하다고 생각한다.