建置和部署新 API（第 1 部分）

這篇部落格文章詳細介紹了建立新 API 的初步步驟，重點是設定專案結構和產生初始程式碼。 目標是使用各種現代工具創建強大且可測試的 API。

技術堆疊包含：用於規範的OpenAPI、用於伺服器產生的oapi-codegen、用於測試的Testify、用於覆蓋率報告的Codecov、用於容器化的Docker、用於資料庫的PostgreSQL、用於ORM 的GORM、用於資料庫遷移的Flyway、用於編排的Kubernetes ，Terraform 用於基礎設施即程式碼，Caddy 作為潛在的Web 伺服器。

API 規範：

專案從一個 User 資源的簡單 OpenAPI 規格開始。 User 架構包括 id、email 和 name。 id 是唯讀的，email 是只寫的。

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

此架構將用於在 /users 定義 POST 端點，成功時傳回 201（已建立）狀態代碼，400（錯誤請求）錯誤時傳回問題詳細資料 JSON 物件。

程式碼產生：

oapi-codegen 用於根據 OpenAPI 規格產生伺服器程式碼。 設定檔（server.config.yaml 和 types.config.yaml）用於自訂產生的程式碼。 tools.go 檔案利用 go generate 來自動化此流程。

處理程序實作與測試：

創建了一個基本的伺服器結構，實作了產生的伺服器介面。 實作了 PostUser 處理程序，最初傳回 nil 值。 使用 Testify 同時編寫單元測試來定義預期行為。 由於資料庫尚未集成，測試響應目前是硬編碼的。

未來的步驟將涉及建立 main.go 檔案、Dockerfile、整合 Codecov 進行持續測試，以及將 API 連接到 PostgreSQL 資料庫。 專案儲存庫可取得更多詳細資訊：https://www.php.cn/link/f72a23858b9865a40479a3ce3f16649e

以上是建置和部署新 API（第 1 部分）的詳細內容。更多資訊請關注PHP中文網其他相關文章！