#swagger #openapi #flask-apispec
Вопрос:
Я работаю на сервере Flask и рассматриваю возможность его документирования с помощью apispec. Проблема в том, что некоторые функции имеют внутренние заметки или личную информацию, такую как электронные письма разработчиков, заметки о задачах и т. Д.
Можно ли чисто включить их в строку документа функции рядом с yaml для apispec?
Ниже приведен пример игрушки:
@app.route("/api/user/forgot-password", methods=["POST"]) def forgot_password(): """ This API returns stuff. --- post: tags: - user parameters: - name: comments in: body description: >- Include comments. default: true required: false schema: type: boolean responses: '200': description: Null response content: application/json: schema: type: object """ # Internal/original docstring """ TODO: etc. Author: Author --<email@eyenuk.com> Created: 6/28/2018 4:53:29 PM