둘 이상의 YAML 파일이 포함된 개방형 API 사양

REST API를 문서화한 사람이라면 모든 리소스, 경로, 요청 및 스키마가 포함된 전체 YAML 파일을 작성하는 것이 어떤 느낌인지 알지만 갑자기 마지막 줄의 길이가 5자리인 파일입니다. 네, 괴롭습니다.

가장 좋은 애플리케이션은 우리가 직접 만든 애플리케이션이기 때문에 저는 직장에서 API를 문서화하는 바로 이 장소에 있었고 이 문제에 대한 단 하나의 실행 가능한 솔루션을 찾기 위해 많은 검색을 했습니다. 바로 그때 우리의 프로그래머 본능이 등장합니다. 그리고 우리는 우리 자신을 위한 새로운 도구를 만드는 데 예정된 시간의 5배를 소비합니다. 이것이 바로 제가 한 일이며, OpenAPI 사양으로 사용할 단일 boss 파일에 YAML 파일을 병합하기 위해 Go로 작성된 모든 새로운 도구를 여러분과 공유하고 싶습니다.

소개: GOpenAPI

GOpenAPI(Golang OpenAPI)는 dirs.json이라는 파일을 사용하여 실행이 끝날 때 파일과 디렉터리(예, yaml에 해당하는 전체 디렉터리)를 하나의 단일 swagger.yaml 파일로 스캔하는 도구입니다.

소스코드는 여기에서 확인하실 수 있습니다. 저장소는 이 도구를 사용하여 첫 번째 OpenAPI 사양을 생성하기 위해 복제하고 초안으로 사용할 수 있는 템플릿이기도 합니다(go install을 통해 설치하지 않으려는 경우 gopenapi 폴더를 유지해야 합니다. 그렇지 않으면 완전히 제거 가능)

어떻게 작동하나요? (그리고 작동시키나요?)

간단합니다. gopenapi를 실행하면 dirs.json 파일을 읽고 거기에 선언된 모든 파일과 폴더가 포함된 OpenAPI 사양을 빌드하기 시작합니다. dirs.json은 정보, 서버, 보안과 같은 고유 키와 템플릿이라는 키(빈 OpenAPI yaml 파일)에 대한 파일을 사용합니다.

단일 파일(경로, 스키마, 요청 등)에 보관하기 어려운 리소스와 키는 폴더에 저장할 수 있으며 OpenAPI에서 공통 #ref 태그를 사용하여 언급할 수도 있습니다. 병합 후 동일한 파일로 이동합니다.

이 프로젝트에는 정적으로 제공될 수 있는 index.html도 함께 제공되며 dist 폴더에 포함된 Swagger UI 공식 번들과도 상호작용합니다.

그게 다예요 여러분

원하는 도구를 찾지 못해 수많은 레딧과 github 저장소를 검색한 사람(나처럼)에게 이 도구가 제공되기를 바랍니다. 이제 여러분은 이를 갖게 되었으며 완전한 오픈 소스가 되었습니다. 즉, 해결 가능한 개선 사항이나 문제가 있으면 이를 해결하기 위해 여러분과 협력하기 전에 두 번 생각하지 않을 것임을 의미합니다. 그리고 저는 golang에 대해 너무 순진해서 이 프로젝트에서 개선할 점이 많을 수도 있습니다. 최신 상태를 유지하고 지속적으로 개선하도록 노력하겠습니다(나도 golang을 많이 사용할 것이기 때문에)

읽어주셔서 감사합니다. 저에게 그랬던 것처럼 이 내용이 여러분에게도 도움이 되기를 바랍니다 ;)

위 내용은 둘 이상의 YAML 파일이 포함된 개방형 API 사양의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!