programing

Swagger JSON을 RAML/YAML로 변환

stoneblock 2023. 3. 15. 17:47

Swagger JSON을 RAML/YAML로 변환

Swagger JSON을 RAML/YAML로 변환하고 검증하려면 어떻게 해야 합니까?나는 프로그램적인 방법을 찾고 있는 것이 아니라, 단지 일회성 전환을 찾고 있다.

스텝은 다음과 같습니다.

  1. Swagger JSON을 드라이브의 파일로 내보냅니다.이 JSON은 /swagger/docs/v1의 URI로 서버에 게시됩니다.
  2. http://editor.swagger.io/ #/ 에 접속합니다.
  3. 왼쪽 상단 모서리에서 [파일]-> [파일 Import...]를 선택합니다.1단계에서 내보낸 로컬 Swagger JSON 파일을 가리키면 Swagger Editor에서 열립니다.
  4. 메뉴에서 [Generate Client]-> [ Swagger YAML ]옵션을 선택합니다.
  5. 그러면 http://www.yamllint.com/ 사이트에서 확인할 수 있는YAML이 생성됩니다.

API 사양을 다양한 형식(Swagger/OpenAPI, RAML, Postman 등) 간에 변환하려면 다음과 같은 무료 및 오픈 소스 도구를 사용할 수 있습니다.

변환

어떤 버전의 Swagger에서 RAML 0.8로 변환하기를 원하신다면 APITransformer.com을 이용하시기 바랍니다.RAML 1.0 내보내기가 거의 완료되었습니다.일주일 안에 출시할 예정입니다.

확인

변환된 설명은 SDK/클라이언트 라이브러리를 생성하기 전에 API 기술을 검증하기 위해 APIMatic이 사용하는 것과 동일한 코드 생성 엔진에서 나옵니다.따라서 변환된 RAML은 기본적으로 검증됩니다.

API 설명은 APIMatic의 CLI 또는 API를 통해 검증할 수도 있습니다.

사실 꽤 간단해

swagger 에디터의 Web 버전에서는, 기존의 swagger 파일(JSON/YAML)을 Import 해, 현재 표시되고 있는 설정 파일을 다운로드할 수 있습니다.이 둘을 결합하면 됩니다.

주의: JSON을 YAML로 변환하는 것은 존재하지만 JSON을 RAML로 변환하는 것은 아닙니다.

  1. 먼저 swagger JSON을 http://editor.swagger.io/ #/ ([File]> [ Import File ])으로 Import 합니다.
  2. 설정을 확인하면 대응하는 YAML 버전([File]> [ Download YAML ])을 다운로드합니다.

업로드한 JSON의 YAML 버전이 다운로드 됩니다.

명령줄 툴이 있으면 좋겠지만, 이 회사는 컨버터를 만들고 있는 것 같습니다.

https://apitransformer.com/

언급URL : https://stackoverflow.com/questions/32730224/convert-swagger-json-to-raml-yaml