Flask-RESTful-Swagger: Amalan terbaik yang didokumenkan untuk membina API RESTful dalam Python

Flask-RESTful-Swagger: Amalan terbaik yang didokumenkan untuk membina RESTful API dalam Python

Dalam aplikasi moden, pelbagai API telah menjadi teras kepada keseluruhan sistem. Oleh itu, cara mereka bentuk dan membina API yang cekap adalah isu yang mesti dipertimbangkan oleh setiap pembangun. Dokumentasi API juga merupakan salah satu cabaran yang tidak dapat dielakkan untuk pembangun.

Dalam komuniti Python, Flask boleh dikatakan sebagai salah satu rangka kerja web yang paling popular. Jika anda menggunakan Flask untuk membina API RESTful, perpustakaan Flask-RESTful-Swagger boleh memberi anda penyelesaian yang baik. Dalam artikel ini, kami akan memperkenalkan Flask-RESTful-Swagger, termasuk ciri-cirinya dan cara menggunakannya dalam aplikasi Flask anda.

Flask-RESTful-Swagger: Pengenalan

Flask-RESTful-Swagger ialah perpustakaan untuk mendokumentasikan Flask-RESTful API. Dengan itu, anda boleh menambah penerangan dan ulasan dengan mudah pada API anda dan secara automatik membina dokumentasi yang sepadan dengan UI Swagger.

Swagger ialah spesifikasi untuk reka bentuk, pembinaan, dokumentasi dan penggunaan API. Ia digunakan untuk menerangkan permintaan API dan mesej respons dan maklumat operasi dan parameter lain yang berkaitan. Pada masa yang sama, Swagger juga menyediakan banyak alat praktikal, seperti UI Swagger, yang membolehkan pengguna melihat dan menguji API secara visual dalam penyemak imbas.

Flask-RESTful-Swagger: Ciri-ciri

• Mudah dan mudah digunakan. Flask-RESTful-Swagger menyediakan API yang agak mudah untuk mendokumentasikan API anda.
• UI Swagger Bersepadu. Flask-RESTful-Swagger secara automatik boleh membina dokumentasi yang sepadan dengan UI Swagger dan membenamkannya terus ke dalam aplikasi anda untuk digunakan oleh pengguna.
• API pemformatan sokongan. Flask-RESTful-Swagger menyokong penentuan format respons API, seperti JSON, XML, dll., supaya pengguna boleh mengetahui format respons API.
• Sediakan petua hotspot. UI Swagger Flask-RESTful-Swagger menyediakan fungsi gesaan hotspot yang sangat berguna, membolehkan pengguna memahami dengan cepat keperluan parameter API dan struktur objek tindak balas.

Flask-RESTful-Swagger: Cara menggunakan

Sebelum anda mula menggunakan Flask-RESTful-Swagger, anda perlu memasang perpustakaan Flask-RESTful dan Flask-RESTful-Swagger.

Anda boleh menggunakan arahan pip untuk melengkapkan pemasangan:

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

Pertama, kami ingin mengimport modul yang diperlukan:

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

Seterusnya, kami perlu membuat instantiate aplikasi Flask dan API :

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

Kemudian, kita boleh mentakrifkan kelas sumber dan menggunakan penghias Flask-RESTful untuk menerangkan API seperti berikut:

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!'

Dalam kod di atas, kita menggunakan Bekas penghias Swagger untuk menerangkan maklumat meta API. Antaranya, @swagger.operation ialah penghias yang digunakan untuk menerangkan operasi API. Kita boleh menggunakannya untuk menentukan nama, perihalan, parameter, tindak balas dan maklumat lain operasi.

Seterusnya, kita perlu menambah kelas sumber pada API seperti berikut:

api.add_resource(Hello, '/hello')

Akhir sekali, selepas melancarkan aplikasi, kita boleh mengaksesnya dengan mengakses http://localhost:5000/api /doc untuk melihat dokumentasi API dan menguji API.

Flask-RESTful-Swagger: Ringkasan

Dalam artikel ini, kami memperkenalkan perpustakaan Flask-RESTful-Swagger dan menerangkan ciri-cirinya serta cara menggunakannya untuk mendokumentasikan Flask-RESTful API. Sebagai amalan terbaik untuk API RESTful yang didokumenkan, Flask-RESTful-Swagger bukan sahaja menyediakan API yang ringkas dan mudah digunakan, tetapi juga menyediakan fungsi seperti menyepadukan UI Swagger, menyokong API berformat dan menyediakan petua tempat liputan. Ringkasnya, menggunakan Flask-RESTful-Swagger untuk mendokumentasikan API aplikasi Flask anda akan menjadi pilihan yang bijak untuk anda.

Atas ialah kandungan terperinci Flask-RESTful-Swagger: Amalan terbaik yang didokumenkan untuk membina API RESTful dalam Python. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!