我是 SwaggerUI 新手。在我的 python 代码中,我有一个名为“work”的 API,它支持 POST、PUT 和 DELETE HTTP 方法。
现在我想为此创建 Swagger 文档。我正在使用以下代码:
@app.route('/work', methods=['POST', 'PUT', 'DELETE'])
def work():
"""
Micro Service Based API for work operations
This API is for work to task matching operations
---
paths:
/cv:
put:
parameters:
- name: body
in: body
required: true
schema:
id: data
properties:
_id:
type: string
description: Id
responses:
200:
description: Please wait the calculation, you'll receive an email with results
delete:
parameters:
- name: body
in: body
required: true
schema:
id: data
properties:
_id:
type: string
description: Id
responses:
200:
description: Please wait the calculation, you'll receive an email with results
post:
responses:
200:
description: done
"""
但是,这似乎不起作用。
我尝试浏览以下文档链接,但没有太大帮助 https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#pathsObject
你能帮我一下吗?
每个 HTTP 方法请求的参数都不同,我还希望在 HTTP UI 中为每个方法指定不同的描述。
编辑
将此添加到index.yml 文件。
swagger: "2.0"
info:
description: "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters."
version: "1.0.0"
title: "Swagger Petstore"
schemes:
- "http"
paths:
/work:
put:
tags:
- "WORK"
summary: "Update a Work Score"
description: ""
consumes:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Work ID whose score needs to be updates"
required: true
schema:
$ref: "#/definitions/Data"
responses:
200:
description: "Invalid input"
/scoreCompute:
post:
tags:
- "ABCD"
summary: "Compute ABCD"
description: ""
consumes:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Compute ABCD"
required: true
schema:
$ref: "#/definitions/TaskId"
responses:
200:
description: "Invalid input"
definitions:
Data:
type: object
properties:
_id:
type: string
description: Enter ID
TaskId:
type: object
properties:
job_id:
type: string
description: Enter ID
对 python 代码进行了上述更改。
@app.route('/work', methods=['POST', 'PUT', 'DELETE'])
@swag_from('index.yml')
def work():
最佳答案
如果您使用 Flasgger ( http://github.com/rochacbruno/flasgger ) 遗憾的是,它还不支持在同一个文档字符串中定义不同的 HTTP 方法, 有这个issue opened .
但是,有一个解决方法可以使其正常工作。
1) 将您的 YAML 放在单独的文件中
2)从Swagger template_file加载它
YAML 文件,另存为 test.yaml:
definitions:
Data:
type: object
properties:
_id:
type: string
paths:
/cv:
put:
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/Data'
responses:
200:
description: |
Please wait the calculation, you'll receive an email with results
delete:
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/Data'
responses:
200:
description: |
Please wait the calculation, you'll receive an email with results
post:
responses:
200:
description: done
然后是test.py
from flask import Flask
from flasgger import Swagger
app = Flask(__name__)
Swagger(app, template_file='test.yaml')
@app.route('/cv', methods=['POST', 'PUT', 'DELETE'])
def cv():
"""
Micro Service Based API for CV operations
This API is for job to CVs matching operations
"""
app.run(debug=True)
你会得到
关于python - 使用 Swagger 的同一 def 中的 HTTP 方法的语法,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/44368166/