Alat Python Trimmer OpenAPI

Memudahkan Fail OpenAPI Anda dengan Pemangkas OpenAPI

Menguruskan fail OpenAPI yang besar boleh menyusahkan, terutamanya apabila anda hanya memerlukan sebahagian kecil API untuk tugasan tertentu. Di sinilah OpenAPI Trimmer berguna. Ia adalah alat ringan yang direka untuk mengurangkan fail OpenAPI anda untuk memasukkan hanya titik akhir dan objek pemindahan data (DTO) yang anda sayangi.

Bagaimana Ia Berfungsi?

Katakan anda sedang bekerja dengan fail OpenAPI yang besar, tetapi anda hanya memerlukan titik akhir yang berkaitan dengan API Petikan. Anda boleh mengekstrak titik akhir tersebut dengan mudah dan mengalih keluar DTO yang tidak berkaitan dengan satu arahan:

openapi-trimmer -i openapi.yaml \
  -p /v1/quotes,/v1/users \
  -ec CompanyConfigDto,UpdateCompanyConfigDto

Arahan ini akan:

• -i openapi.yaml: Gunakan fail OpenAPI YAML sedia ada anda sebagai input.
• -p /v1/quotes,/v1/users: Simpan hanya titik akhir bermula dengan /v1/quotes dan /v1/users.
• -ec CompanyConfigDto,UpdateCompanyConfigDto: Kecualikan komponen tertentu, dalam kes ini, CompanyConfigDto dan UpdateCompanyConfigDto.

Takrifan API yang dipangkas akan disimpan sebagai openapi-trimmer.yaml.

Pengesahan

Untuk memastikan integriti fail OpenAPI anda yang dipangkas, sahkan dengan:

swagger-cli validate ./openapi-trimmer.yaml

Langkah ini membantu menangkap sebarang isu sebelum anda menggunakan atau berkongsi fail API yang dipangkas.

Pemasangan

Anda boleh memasang OpenAPI Trimmer terus daripada PyPi:

pip install openapi-trimmer

Untuk butiran lanjut dan kemas kini terkini, lawati halaman OpenAPI Trimmer PyPi.

Repositori GitHub: Pemangkas OpenAPI pada GitHub.

Pilihan Baris Perintah

Pemangkas OpenAPI menawarkan beberapa pilihan untuk menyesuaikan operasinya:

• -h, --help: Tunjukkan maklumat bantuan.
• -v, --version: Paparkan nombor versi.
• -i INPUT, --input INPUT: Tentukan input fail YAML (diperlukan).
• -o OUTPUT, --output OUTPUT: Tentukan nama fail output (pilihan; lalai untuk menambahkan '-trimmed' pada fail input).
• -p AWAL, --awalan AWAL: Senaraikan laluan untuk dikekalkan dalam output (dipisahkan koma).
• -ec EXCLUDE_COMPONENTS, --exclude-components EXCLUDE_COMPONENTS: Senaraikan komponen untuk dikecualikan (dipisahkan koma).

Kesimpulan

OpenAPI Trimmer ialah alat penting untuk pembangun yang ingin menyelaraskan fail OpenAPI mereka, menjadikannya lebih mudah diurus dan disesuaikan dengan keperluan khusus. Sama ada anda sedang menyediakan dokumentasi API atau memudahkan API untuk kegunaan dalaman, Pemangkas OpenAPI menjimatkan masa dan usaha anda dengan hanya memfokus pada perkara yang paling penting bagi anda.

Atas ialah kandungan terperinci Alat Python Trimmer OpenAPI. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!