在Debian环境下生成Swagger文档,通常需要以下几个步骤:
安装必要的软件包:
sudo apt update sudo apt install python3-pip python3-venv
python3 -m venv swagger-env source swagger-env/bin/activate
pip install flasgger # 或者 pip install drf-yasg
编写Swagger配置:
根据你使用的框架(如Flask或Django),编写Swagger配置文件。
使用Flask和flasgger:
from flask import Flask, jsonify from flasgger import Swagger app = Flask(__name__) swagger = Swagger(app) @app.route('/api/v1/hello', methods=['GET']) def hello(): """This is a sample endpoint.""" return jsonify(message="Hello, World!") if __name__ == '__main__': app.run(debug=True)
使用Django和DRF-YASG:
pip install drf-yasg
settings.py
中添加drf_yasg
到INSTALLED_APPS
。urls.py
文件,并添加Swagger配置。from django.urls import path, include from rest_framework import permissions from drf_yasg.views import get_schema_view from drf_yasg import openapischema_view get_schema_view( openapi.Info( title="Sample API", default_version='v1', description="API documentation for Sample API", ), public=True, permission_classes=(permissions.AllowAny,), ) urlpatterns = [ path('swagger/', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'), path('redoc/', schema_view.with_ui('redoc', cache_timeout=0), name='schema-redoc'), ]
运行应用:
python app.py
python manage.py runserver
访问Swagger UI:
http://127.0.0.1:5000/apidocs
(默认端口和路径)http://127.0.0.1:8000/swagger/
(默认端口和路径)通过以上步骤,你可以在Debian系统上成功生成并访问Swagger API文档。