Membina dan Meletakkan API Baharu (Bahagian 1)

Catatan blog ini memperincikan langkah awal dalam membina API baharu, memfokuskan pada menyediakan struktur projek dan menjana kod awal. Matlamatnya ialah untuk mencipta API yang teguh dan boleh diuji menggunakan pelbagai alatan moden.

Timbunan teknologi termasuk: OpenAPI untuk spesifikasi, oapi-codegen untuk penjanaan pelayan, Testify untuk ujian, Codecov untuk pelaporan liputan, Docker untuk kontena, PostgreSQL untuk pangkalan data, GORM sebagai ORM, Flyway untuk migrasi pangkalan data, Kubernetes untuk orkestrasi , Terraform untuk infrastruktur sebagai kod, dan Caddy sebagai pelayan web yang berpotensi.

Spesifikasi API:

Projek ini bermula dengan spesifikasi OpenAPI yang mudah untuk sumber User. Skema User termasuk id, email dan name. id ialah baca sahaja dan email ialah tulis sahaja.

<code>components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: string
          example: 123
          readOnly: true
        email:
          type: string
          example: me@example.com
          writeOnly: true
        name: 
          type: string
          example: Alice</code>

Skema ini akan digunakan untuk mentakrifkan titik akhir POST pada /users, mengembalikan kod status 201 (Dibuat) pada kejayaan dan Objek JSON Butiran Masalah untuk 400 (Permintaan Buruk).

Penjanaan Kod:

oapi-codegen digunakan untuk menjana kod pelayan daripada spesifikasi OpenAPI. Fail konfigurasi (server.config.yaml dan types.config.yaml) digunakan untuk menyesuaikan kod yang dijana. Fail tools.go menggunakan go generate untuk mengautomasikan proses ini.

Pelaksanaan dan Pengujian Pengendali:

Struktur pelayan asas dicipta, melaksanakan antara muka pelayan yang dijana. Pengendali PostUser dilaksanakan, pada mulanya mengembalikan nilai nil. Ujian unit menggunakan Testify ditulis serentak untuk menentukan tingkah laku yang diharapkan. Memandangkan pangkalan data belum disepadukan, respons ujian dikodkan keras buat masa ini.

Langkah akan datang akan melibatkan penciptaan fail main.go, Dockerfile, menyepadukan Codecov untuk ujian berterusan dan menyambungkan API ke pangkalan data PostgreSQL. Repositori projek tersedia untuk butiran lanjut: https://www.php.cn/link/f72a23858b9865a40479a3ce3f16649e

Atas ialah kandungan terperinci Membina dan Meletakkan API Baharu (Bahagian 1). Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!