Skip to content

API 设计

API Design

我们可以协助您为 Web 应用程序设计 RESTful API 路由。

在开发您的 API 路由时,我们同样遵循软件开发生命周期中概述的各个阶段:规划、设计、实现、测试和部署。

规划 ​

我们在规划阶段对您的期望 ​

  1. 预计您需要为此次会议在日间安排最多 2 小时的时间。
  2. 需求文档是根据您提供的信息制定的。您需要:
    • 了解您的用户:管理员、访客等。
    • 了解用户可以使用您的 API 做什么:
      • 对您的 Web 应用程序中的信息进行创建、读取、更新或删除操作。
    • 了解用户如何访问您的 API:
      • 向您的 Web 应用程序发送 POST、GET、PUT 和 DELETE 请求。

在规划阶段,您可以期待我们提供什么 ​

  1. 基于您提供的信息制定的最终版 API 需求文档。
  2. 上述文件必须先获批准,方可进入设计阶段。

设计与实现 ​

  1. OpenAPI 文档是根据您的需求编写的。
  2. 下面提供了一个 .yaml 文件的示例:
openapi: '3.1.0'
info:
  version: '1.0.0'
  title: 'Sample API'
  description: Sample API for the recipes and restaurants

servers:
  - url: https://stuntbusiness.cdapi

paths:
      
  /recipe:
    get:
      security: 
          - bearerAuth: [] 
      summary: Get the list of recipes
      operationId: getAllRecipes
      responses:
        200:
          description: The array of recipes 
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Recipes"
        500:
          description: Unexpected error 
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

    # Other paths here.
  • 我们也可以负责上述 YAML 文件在您后端环境中的实施工作,并将按后端开发的常规费率收取费用。

测试与部署 ​

  • 我们负责处理您的 API 测试,并向您提供一份测试清单。
  • 我们负责处理您的 API 测试,并向您提供一份测试清单。

费率 ​

TablesHourly rate
HTTP API Design125 000 FC/hour
Back-end development125 000 FC/hour

准备好点餐了吗? ​