У меня есть app.py, в котором есть все конечные точки API, и когда вы создаете документацию, все api.add_resources заключены в него. функция.
Код: Выделить всё
from resources.recipes import GetRecipes, RecipeList,
from resources.employees import Chefs, Servers, Admin
def make_port():
api = Api(app)
api.add_resource(GetRecipes, '/getrecipes/')
api.add_resource(RecipeList, '/allrecipes/')
api.add_resource(Chefs, '/chefs/')
api.add_resource(Servers, '/servers/')
api.add_resource(Admin, '/admin/')
return app
Код: Выделить всё
API Documentation
=================
Summary
-------
.. qrefflask:: app:make_port()
:undoc-static:
API Details
-----------
.. autoflask:: app:make_port()
:endpoints: getRecipes, RecipeList, Chefs, Servers, Admin
:undoc-static
Я пробовал просто импортировать папку «ресурсы/сотрудники, ресурсы/рецепты» в модули.сначала
Код: Выделить всё
.. toctree::
: maxdepth: 4
app
resources/employees
resources/recipes
Я хотел бы организовать конечные точки вручную
Strong>, поскольку некоторые конечные точки достаточно похожи, чтобы их можно было сгруппировать вместе.
Я новичок в этом проекте и sphinx, и мне не удалось разобраться в документации Sphinx.
Подробнее здесь: https://stackoverflow.com/questions/787 ... -endpoints