swagger codegen swagger codegen 작성 방법 .json

Question

최근 RESTful API를 작성중인 팀에 가입했습니다. 나는이 분야의 초보자입니다. 내 임무는 프로젝트의 SDK를 만드는 것입니다. 나는 그것을 위해 swagger-codegen을 사용해야한다. 나는 지침을 따르고있다 swagger-codegen

거기 그들은 http://petstore.swagger.io/v2/swagger.json 파일을 사용하고있다. 그러나 내 프로젝트에는 .json 파일을 사용할 수 없습니다. 내가 mvn 클린 패키지을 사용하여 프로젝트를 빌드하면 .war 파일이 있습니다.

그래서 내가 알고 싶은 것은 .json 파일을 만들어 SDK를 작성해야합니까, 그렇다면 어떻게 구축해야합니까? 아니면 다른 방법으로 할 수 있습니까?

내 지식 부족에 대해 사과드립니다.

Answer 1

시작하려면 REST API를 OpenAPI/Swagger spec 2.0 (yaml/json 파일)에 문서화해야합니다.

C# Swashbuckle과 같은 플러그인을 사용하여 RESTful 백엔드에서 자동으로 OpenAPI/Swagger 사양을 생성 할 수도 있습니다.

spec (yaml/json 파일)을 얻은 후 Swagger Codegen (무료, 오픈 소스)을 사용하여 API 클라이언트, 서버 스텁 및 API 문서를 생성 할 수 있습니다.

참고하시기 바랍니다. OpenAPI 3.0 (RC)은 다음에서 찾을 수 있습니다. https://github.com/OAI/OpenAPI-Specification/blob/3.0.0-rc0/versions/3.0.md