오픈 api 예제

By | August 2, 2019

온라인에는 다른 Swagger/OpenAPI 자습서가 있지만 2.0이 아닌 3.0 버전의 API에 대한 자습서를 따라야 합니다. 버전 3.0은 2017년 7월에 릴리스되었습니다. 3.0은 2.0과 크게 다릅니다. 버전 3.0.2는 2017년 12월에 릴리스되었으며 3.0으로 약간 개선되었습니다. 3.0을 참조할 때마다 3.x를 참조하는데, 이는 3.0 줄에서 점이 해제된다는 것을 의미합니다.) OpenAPI 사양 파일을 작성하면 다음과 같이 사용할 수도 있습니다. 또한 위의 코드에서는 설명이 있는 선택적 요약 키를 사용했습니다. 주: 지정한 샘플 값은 매개 변수 데이터 형식과 일치해야 합니다. 사양의 구성 요소/예제 섹션에서 일반적인 예제를 정의한 다음 다양한 매개 변수 설명, 요청 및 응답 본문 설명, 개체 및 proeprties에서 다시 사용할 수 있습니다. 핵심 비즈니스에 가치를 더하는 혁신적인 애플리케이션을 만들 수 있는 프리랜서 개발자 커뮤니티가 끊임없이 성장하고 있습니다. 개방형 API는 개발 노력에 직접 투자하지 않고도 새로운 아이디어의 생산을 동시에 증가시키는 비즈니스 영역에서 선호됩니다. 기업은 종종 중요한 새 응용 프로그램을 만드는 데 가장 효과적이라고 생각되는 특정 개발자 대상을 타겟팅하도록 API를 조정합니다. 그러나 API가 기능으로 오버로드되는 경우 API는 응용 프로그램의 기능을 크게 저하시킬 수 있습니다.

개방형 API 사양 파일은 JSON 또는 YAML로 작성할 수 있습니다. 그러나이 파일을 작성하고 생성하지 않으려면 YAML이 JSON보다 훨씬 쉽게 작성하고 읽을 수 있으므로 YAML에서 그렇게할 것을 촉구합니다. 물론 다른 많은 디스플레이 프레임워크는 OpenAPI 사양 문서에 정보를 구문 분석하고 표시할 수 있지만 Swagger UI는 가장 인기 있는 것 중 하나입니다. Swagger UI는 OpenAPI 이니셔티브에 많이 투자되고 Swaggerhub를 개발하는 동일한 회사인 SmartBear가 후원합니다. 그들의 툴링은 거의 항상 최신 사양 기능과 동기화됩니다. Swagger UI적극적으로 개발 및 관리 오픈 소스 프로젝트.

Category: Uncategorized