Q. 현업에서의 API 명세

답변 2

• M

  Memory Department삼성전자

  코전무 ∙ 채택률 82%

  ---

  채택된 답변

  안녕하세요! 현업에서 API 문서화를 진행하는 방식은 회사와 팀의 요구 사항, 사용 중인 기술 스택, 그리고 팀의 작업 방식에 따라 다를 수 있습니다. Swagger(현재는 OpenAPI로도 불리는)는 많은 개발자들이 실제로 널리 사용하고 있습니다. Swagger는 API 문서화와 테스트를 동시에 할 수 있어서 개발자들에게 매우 유용한 도구입니다. 자동으로 문서를 생성해주고, 문서와 API 간의 동기화가 잘 되어 있어서 유지보수가 쉽다는 장점이 있습니다. 그렇지만 Swagger만 사용하는 것은 아닙니다. 몇몇 팀에서는 API 문서화를 위한 다른 도구나 방식을 사용하기도 합니다. 예를 들어, Postman은 API 테스트와 문서화를 지원하는 도구로 많이 사용되고, API Blueprint나 RAML 같은 다른 문서화 표준을 사용하기도 합니다. 이러한 도구들은 각자의 장점이 있어서 팀의 필요에 따라 선택되기도 합니다. 도움이 되셨다면 채택 부탁드려요~ 응원합니다~!

  ---
• 각

  각티슈에어부산

  코사장 ∙ 채택률 82%

  ---

  1. 실제로도 스웨거를 많이 사용합니다. 근데, 보통 한글 문서화로 명세를 하고 스웨거도 하고 둘다합니다. 아무래도 스웨거만으로도 충분해 보이지만, 혹시 스웨거에 문제가 생겼을때는 문서를 봐야되기 때문에 둘다한다고 보면 됩니다.

  ---