개인 웹 API 문서

Question

프로젝트 내부 용 웹 API를 설정했습니다. Google API를 문서화하는 좋은 방법을 찾고 있습니다. 나는 자동으로 생성 할 수 있습니다 JSON 파일, 예를 들어, 읽어 이러한 도구를 웹을 검색하고

• IO Docs
• Swagger

발견했습니다 Java 용. 우리의 API가 성장하여 JSON을 수동으로 만들지 만 텍스트 편집기에서 손으로 직접 만들지는 않습니다. 수동 JSON을 작성하는 부담을 덜어주는 도구 또는 프론트 엔드가 있습니까?

반면에 웹 API 문서화에 권장되는 도구는 무엇입니까?

Answer 1

저는 .NET (C#) 샵에서 일하면서 우리의 apis를 문서화하기 위해 swagger를 사용합니다. 우리는 당신이 묻는 것을 할 수있는 도구를 찾을 수 없었습니다 ... 그래서 우리는 단지 우리 자신의 것을 만들었습니다. 나는 그 같은 유틸리티 프로젝트를 창출하기에 충분할만큼 미숙하다고 생각하지 않습니다.

swagger 문서에서 설명하는 json 개체를 나타내는 클래스를 만드는 것이 어렵지 않았습니다. 우리는이 인스턴스화 된 클래스를 JSON 시리얼 라이저를 통해 실행하여 엔드 포인트를 설명하는 개별 json 파일을 얻습니다.

행운을 빈다.