Unduh apistar - pengunduhan kode sumber apistar

apistar

ular piton

1.0.0

Unduh

? Perangkat API Web. ?

Komunitas: https://discuss.apistar.org ? ? ? ?

Dokumentasi: https://docs.apistar.com

Persyaratan: Python 3.6+

API Star adalah toolkit untuk bekerja dengan skema OpenAPI atau Swagger. Ini memungkinkan Anda untuk:

Bangun dokumentasi API, dengan pilihan tema yang tersedia.
Validasi dokumen skema API, dan berikan kesalahan kontekstual.
Buat permintaan API menggunakan perpustakaan klien dinamis.

Anda dapat menggunakannya untuk membuat dokumentasi statis, mengintegrasikannya dalam kerangka Web, atau menggunakannya sebagai perpustakaan klien untuk berinteraksi dengan API lain.

Mulai cepat

Instal Bintang API:

$ pip3 install apistar

Mari kita lihat beberapa fungsi yang disediakan toolkit...

Kita akan mulai dengan membuat skema OpenAPI, schema.yaml :

 openapi : 3.0.0
info :
  title : Widget API
  version : ' 1.0 '
  description : An example API for widgets
servers :
  - url : https://www.example.org/
paths :
  /widgets :
    get :
      summary : List all the widgets.
      operationId : listWidgets
      parameters :
      - in : query
        name : search
        description : Filter widgets by this search term.
        schema :
          type : string

Mari kita juga membuat file konfigurasi apistar.yml :

 schema :
  path : schema.yaml
  format : openapi

Kami sekarang siap untuk mulai menggunakan alat baris perintah apistar .

Kami dapat memvalidasi skema OpenAPI kami:

 $ apistar validate
✓ Valid OpenAPI schema.

Atau buat dokumentasi pengembang untuk API kami:

 $ apistar docs --serve
✓ Documentation available at "http://127.0.0.1:8000/" (Ctrl+C to quit)

Kita juga dapat membuat permintaan API ke server yang direferensikan dalam skema:

 $ apistar request listWidgets search=cogwheel

Kemana perginya servernya?

Dengan versi 0.6 dan seterusnya, proyek API Star difokuskan sebagai rangkaian alat API tanpa kerangka kerja. Rencananya adalah untuk membangun fungsi ini sedemikian rupa sehingga sesuai untuk digunakan baik sebagai alat yang berdiri sendiri, atau bersama-sama dengan sejumlah besar kerangka kerja.

Cabang 0.5 tetap tersedia di GitHub, dan dapat diinstal dari PyPI dengan pip install apistar==0.5.41 . Pengembangan lebih lanjut dari server API Star kemungkinan besar harus bertentangan dengan hal tersebut, di bawah pengelola baru.

Jika Anda mencari kerangka kerja asinkron berbasis Python berkinerja tinggi, saya akan merekomendasikan Starlette.

API Star adalah kode berlisensi BSD.
Dirancang & dibangun di Brighton, Inggris.

Memperluas

Informasi Tambahan