要在CentOS项目中集成Swagger,你需要遵循以下步骤:
pip install swagger-ui-python
app.py的文件,并添加以下代码:from flask import Flask, jsonify
from flasgger import Swagger
app = Flask(__name__)
swagger = Swagger(app)
@app.route('/')
def index():
return jsonify({"message": "Hello, World!"})
if __name__ == '__main__':
app.run(debug=True)
这段代码创建了一个简单的Flask应用,其中包含一个根路由,返回一个JSON响应。
swagger.yaml的文件,并添加以下代码:swagger: '2.0'
info:
title: Sample API
description: A sample API to demonstrate Swagger integration with Flask on CentOS.
version: '1.0.0'
host: localhost:5000
basePath: /
schemes:
- http
paths:
/:
get:
summary: Returns a simple message
responses:
200:
description: A successful response
schema:
type: object
properties:
message:
type: string
这个文件定义了一个简单的Swagger文档,描述了你的API。
app.py文件,以便它使用刚刚创建的Swagger文档。将以下代码添加到app.py文件中:from flasgger import Swagger
# ...
@app.route('/swagger.json')
def swagger_json():
swag = Swagger(app)
return swag.to_json()
# ...
这段代码添加了一个新的路由,用于返回Swagger文档的JSON表示。
python app.py
这将启动Flask应用。
http://localhost:5000/swagger-ui.html
你应该看到一个包含你的API文档的交互式Swagger UI界面。
现在你已经在CentOS项目中成功集成了Swagger。你可以继续添加更多的路由和文档,以便更好地描述你的API。