둘 이상의 YAML 파일이 포함된 개방형 API 사양-Golang-php.cn

집

백엔드 개발

Golang

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

Susan Sarandon

Sep 26, 2024 am 06:10 AM

Open API specs with more than one YAML file

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 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명

본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.

관련 기사

GO의 문자열 조작 : '문자열'패키지 마스터 링May 14, 2025 am 12:19 AM

GO 언어로 문자열 패키지를 마스터하면 텍스트 처리 기능과 개발 효율성이 향상 될 수 있습니다. 1) 함유 기능을 사용하여 하위 문자열을 확인하십시오. 2) 인덱스 기능을 사용하여 하위 문자열 위치를 찾으십시오. 빈 문자열을 확인하지 않고 큰 문자열 작동 성능 문제와 같은 일반적인 오류를 피하기 위해주의하십시오.

'문자열'패키지 팁과 요령으로 이동하십시오May 14, 2025 am 12:18 AM

문자열 조작을 단순화하고 코드를보다 명확하고 효율적으로 만들 수 있기 때문에 이동중인 문자열 패키지에주의해야합니다. 1) strings.join을 사용하여 줄을 효율적으로 스플 라이스; 2) strings.fields를 사용하여 빈 문자로 문자열을 나눕니다. 3) 문자열을 통해 기판 위치를 찾으십시오. 4) 문자열을 대체하려면 strings.replaceall을 사용하십시오. 5) 현악기를 효율적으로 스플 라이스로 사용하여 strings.builder를 사용하십시오. 6) 예상치 못한 결과를 피하기 위해 항상 입력을 확인하십시오.

'문자열'패키지의 이동 : 문자열 작업을위한 이동May 14, 2025 am 12:17 AM

thestringspackageoisessentialponderfficientstringmanipulation.1) itofferssimpleyetpowerfultionsfortaskslikecheckingsubstringsandjoiningstrings.2) ithandlesunicodewell, withFunctionsLikestrings.fieldsforwhitespace-separatedValues.3) forperformance, st

바이트 패키지 대 스트링 패키지로 이동하십시오 : 어떤 사용해야합니까?May 14, 2025 am 12:12 AM

whendecidingbetweengo'sbytespackageandstringspackage, usebytes.bufferforbinarydataandstrings.builderfortringoperations.1) audeBytes.bufferforworkingwhithbyteslices, binarydata, 첨부 DifferentDatatypes, andwritingtoio.2) useastrons

'문자열'패키지를 사용하여 단계별로 문자열을 조작하는 방법May 13, 2025 am 12:12 AM

GO의 문자열 패키지는 다양한 문자열 조작 기능을 제공합니다. 1) 문자열을 사용하여 기판을 확인하십시오. 2) strings.split을 사용하여 문자열을 서브 스트링 슬라이스로 분할하십시오. 3) 문자열을 통해 문자열을 병합합니다. 4) 문자열의 시작과 끝에서 strings.trimspace 또는 strings.trim을 사용하여 공백 또는 지정된 문자를 제거하십시오. 5) 지정된 모든 하위 문구를 문자열로 교체하십시오. 6) strings.hasprefix 또는 strings.hassuffix를 사용하여 문자열의 접두사 또는 접미사를 확인하십시오.

Go Strings 패키지 : 코드를 개선하는 방법?May 13, 2025 am 12:10 AM

Go Language Strings 패키지를 사용하면 코드 품질이 향상 될 수 있습니다. 1) strings.join ()을 사용하여 성능 오버 헤드를 피하기 위해 문자열 배열을 우아하게 연결하십시오. 2) strings.split () 및 strings.contains ()를 결합하여 텍스트를 처리하고 사례 민감도 문제에주의를 기울입니다. 3) 문자열의 남용을 피하고 ()을 replace ()하고 많은 수의 대체에 정규 표현식을 사용하는 것을 고려하십시오. 4) strings.builder를 사용하여 자주 스 플라이 싱 스트링의 성능을 향상시킵니다.

Go Bytes 패키지에서 가장 유용한 기능은 무엇입니까?May 13, 2025 am 12:09 AM

GO의 바이트 패키지는 바이트 슬라이싱을 처리하기위한 다양한 실용적인 기능을 제공합니다. 1. BYTES는 바이트 슬라이스에 특정 시퀀스가 포함되어 있는지 확인하는 데 사용됩니다. 2.Bytes.split은 바이트 슬라이스를 작은 피스로 분할하는 데 사용됩니다. 3.Bytes.join은 여러 바이트 슬라이스를 하나로 연결하는 데 사용됩니다. 4.bytes.trimspace는 바이트 슬라이스의 전면 및 후면 블랭크를 제거하는 데 사용됩니다. 5.Bytes.equal은 두 바이트 슬라이스가 동일인지 비교하는 데 사용됩니다. 6.bytes.index는 LargersLices에서 하위 슬라이스의 시작 지수를 찾는 데 사용됩니다.

GO의 '인코딩/바이너리'패키지로 바이너리 데이터 처리 마스터 링 : 포괄적 인 가이드May 13, 2025 am 12:07 AM

Theencoding/BinaryPackageInsentialBecauseItProvideAstandAdizedWayStandwriteBinaryData, Cross-PlatformCompatibility 및 HandshandlingDifferentendianness.ItoffersFunctionsLikeRead, Write, andwriteUvarIntForPrecisControloverbinary

See all articles