Flask-RESTful-Swagger: Python で RESTful API を構築するための文書化されたベストプラクティス-Python チュートリアル-php.cn

Flask-RESTful-Swagger: Python で RESTful API を構築するための文書化されたベストプラクティス

WBOY

リリース： 2023-06-17 14:46:40

オリジナル

1862 人が閲覧しました

Flask-RESTful-Swagger: Python で RESTful API を構築するための文書化されたベストプラクティス

最新のアプリケーションでは、さまざまな API がシステム全体の核となっています。したがって、効率的な API をどのように設計して構築するかは、すべての開発者が考慮する必要がある問題です。 API のドキュメント化も、開発者にとって避けられない課題の 1 つです。

Flask は Python コミュニティにおいて、非常に人気のある Web フレームワークの 1 つと言えます。 Flask を使用して RESTful API を構築している場合は、Flask-RESTful-Swagger ライブラリが優れたソリューションを提供します。この記事では、Flask-RESTful-Swagger について、その機能と Flask アプリケーションでの使用方法を含めて紹介します。

Flask-RESTful-Swagger: はじめに

Flask-RESTful-Swagger は、Flask-RESTful API を文書化するためのライブラリです。これを使用すると、API に説明やコメントを簡単に追加し、Swagger UI に対応するドキュメントを自動的に構築できます。

Swagger は、API の設計、構築、ドキュメント、および使用のための仕様です。これは、API 要求および応答メッセージ、およびその他の関連する操作およびパラメーター情報を記述するために使用されます。同時に、Swagger は、ユーザーがブラウザーで API を視覚的に表示およびテストできるようにする Swagger UI など、多くの実用的なツールも提供します。

Flask-RESTful-Swagger: 機能

シンプルで使いやすい。 Flask-RESTful-Swagger は、API を文書化するための比較的シンプルな API を提供します。
Swagger UI を統合します。 Flask-RESTful-Swagger は、Swagger UI に対応するドキュメントを自動的に構築し、ユーザーが利用できるようにアプリケーションに直接埋め込むことができます。
フォーマット API をサポートします。 Flask-RESTful-Swagger は、JSON、XML などの API 応答形式の定義をサポートしているため、ユーザーは API 応答形式を知ることができます。
ホットなヒントを提供します。 Flask-RESTful-Swagger の Swagger UI は、非常に便利なホットスポットプロンプト機能を提供し、ユーザーが API パラメーター要件と応答オブジェクトの構造をすぐに理解できるようにします。

Flask-RESTful-Swagger: 使用方法

Flask-RESTful-Swagger の使用を開始する前に、Flask-RESTful ライブラリと Flask-RESTful-Swagger ライブラリをインストールする必要があります。

pip コマンドを使用してインストールを完了できます:

pip install flask-restful
pip install flask-restful-swagger

ログイン後にコピー

まず、必要なモジュールをインポートする必要があります:

from flask import Flask
from flask_restful import Api, Resource, reqparse
from flask_restful_swagger import swagger

ログイン後にコピー

次に、Flask アプリケーションをインスタンス化する必要がありますおよび API :

app = Flask(__name__)
api = Api(app)

ログイン後にコピー

次に、次のように、リソースクラスを定義し、Flask-RESTful のデコレータを使用して API を記述します。

class Hello(Resource):

    @swagger.operation(
        notes='获取问候语', 
        responseClass=str, 
        nickname='hello', 
        parameters=[],
        responseMessages=[
            {
                'code': 200,
                'message': '获取成功'
            },
            {
                'code': 500,
                'message': '服务器异常'
            }
        ]
    )
    def get(self):
        """
        获取问候语
        :return: 问候语
        """
        return 'Hello, World!'

ログイン後にコピー

上記のコードでは、Swagger のデコレータコンテナを使用して、 APIのメタ情報を記述します。このうち、@swagger.operation は API の操作を記述するために使用されるデコレータです。これを使用して、操作の名前、説明、パラメーター、応答、その他の情報を定義できます。

次に、次のように API にリソースクラスを追加する必要があります:

api.add_resource(Hello, '/hello')

ログイン後にコピー

最後に、アプリケーションを起動した後、http://localhost:5000/api にアクセスしてアクセスできます。 /doc を使用して API ドキュメントを表示し、API をテストします。

Flask-RESTful-Swagger: 概要

この記事では、Flask-RESTful-Swagger ライブラリを紹介し、その機能とそれを使用して Flask-RESTful API を文書化する方法について説明しました。文書化された RESTful API のベストプラクティスとして、Flask-RESTful-Swagger はシンプルで使いやすい API を提供するだけでなく、Swagger UI の統合、フォーマットされた API のサポート、ホットスポットヒントの提供などの機能も提供します。つまり、Flask-RESTful-Swagger を使用して Flask アプリケーションの API を文書化するのは賢明な選択です。

以上がFlask-RESTful-Swagger: Python で RESTful API を構築するための文書化されたベストプラクティスの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。