Debian环境下Swagger文档如何生成 - 问答

在Debian环境下生成Swagger文档，通常需要以下几个步骤：

安装必要的软件包：
- 确保你的Debian系统已经安装了pip（Python的包管理工具）和virtualenv（用于创建隔离的Python环境）。
```
sudo apt update
sudo apt install python3-pip python3-venv
```
- 创建一个新的虚拟环境来隔离项目的依赖。
```
python3 -m venv swagger-env
source swagger-env/bin/activate
```
- 安装Swagger相关的Python库，例如flasgger或drf-yasg。
```
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。

在Django项目的根目录下创建一个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'),
]

运行应用：
- 运行你的Flask应用。
```
python app.py
```
- 启动Django应用。
```
python manage.py runserver
```
访问Swagger UI：
- 打开浏览器，访问Swagger UI界面。
  - 对于Flask和flasgger：http://127.0.0.1:5000/apidocs（默认端口和路径）
  - 对于Django和DRF-YASG：http://127.0.0.1:8000/swagger/（默认端口和路径）

通过以上步骤，你可以在Debian系统上成功生成并访问Swagger API文档。

0 赞

0 踩