OpenAPI 3.0 사용 방법
제작 이해 OpenAPI 3.0/conneexion
설명 사양
GET에서 방문http://localhost:8080/api/v0/health에 응답했다.
ex02.yaml
openapi: 3.0.0
info:
title: OpenAPI Tutorial
description: OpenAPI Tutorial by halhorn
version: 0.0.0
servers:
- url: https://example.com/api/v0
description: プロダクション API
- url: http://{host}:{port}/api/v0
description: 開発用
variables:
host:
default: localhost
port:
default: '10080'
paths:
/health:
get:
operationId: openapitutorial.controller.health.call
summary: サーバーの状態を返します
description: サーバーの状態を返します。
responses:
'200':
description: サーバーは正常に動作しています
content:
application/json:
schema:
$ref: '#/components/schemas/get_health_response'
components:
schemas:
get_health_response:
description: サーバーの状態のレスポンス
type: object
properties:
status:
type: string
enum:
- ok
required:
- status
파리에서 데이트https://editor.swagger.io/
JSON으로 변환
File -> convert and save as JSON
ex02.json
{
"openapi": "3.0.0",
"info": {
"title": "OpenAPI Tutorial",
"description": "OpenAPI Tutorial by halhorn",
"version": "0.0.0"
},
"servers": [
{
"url": "https://example.com/api/v0",
"description": "プロダクション API"
},
{
"url": "http://{host}:{port}/api/v0",
"description": "開発用",
"variables": {
"host": {
"default": "localhost"
},
"port": {
"default": "10080"
}
}
}
],
"paths": {
"/health": {
"get": {
"operationId": "openapitutorial.controller.health.call",
"summary": "サーバーの状態を返します",
"description": "サーバーの状態を返します。",
"responses": {
"200": {
"description": "サーバーは正常に動作しています",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/get_health_response"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"get_health_response": {
"description": "サーバーの状態のレスポンス",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"ok"
]
}
},
"required": [
"status"
]
}
}
}
}
Flash 서버 만들기
Generate Server -> python-flask
python-flask-server-generated.zip을 내다
해동
unzip python-flask-server-generated.zip
장서고를 설치하다pip3 install -r requirements.txt
실행 서버python3 -m swagger_server
클라이언트를 통한 액세스$ http http://0.0.0.0:8080/api/v0/health
HTTP/1.0 200 OK
Content-Length: 17
Content-Type: application/json
Date: Fri, 22 Oct 2021 02:14:59 GMT
Server: Werkzeug/1.0.1 Python/3.9.7
"do some magic!"
관련 페이지
OpenAPI 3.0 사용 방법(GET 매개변수 포함)
Reference
이 문제에 관하여(OpenAPI 3.0 사용 방법), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다 https://qiita.com/ekzemplaro/items/2469fcf12ca023e44d90텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.
우수한 개발자 콘텐츠 발견에 전념 (Collection and Share based on the CC Protocol.)