## 使用回调的应用 { #an-app-with-callbacks }

示例如下。

假设要开发一个创建发票的应用。

发票包括 `id`、`title`（可选）、`customer`、`total` 等属性。

API 的用户（外部开发者）要在您的 API 内使用 POST 请求创建一条发票记录。

（假设）您的 API 将：

* 把发票发送至外部开发者的消费者
* 归集现金
* 把通知发送至 API 的用户（外部开发者）
    * 通过（从您的 API）发送 POST 请求至外部 API（即**回调**）来完成

## 常规 **FastAPI** 应用 { #the-normal-fastapi-app }

添加回调前，首先看下常规 API 应用是什么样子。

## FastAPI と OpenAPI による Webhook のドキュメント化 { #documenting-webhooks-with-fastapi-and-openapi }

**FastAPI** と OpenAPI を使うと、Webhook の名前、アプリが送信できる HTTP の操作（例: `POST`, `PUT` など）、アプリが送るリクエストの**ボディ**を定義できます。

これにより、ユーザーがあなたの **Webhook** リクエストを受け取るための**API を実装**するのが大幅に簡単になります。場合によっては、ユーザーが自分たちの API コードを自動生成できるかもしれません。

/// info | 情報

    private static final String DOC_ID_FIELD = "doc_id";

    /**
     * The GET method.
     */
    protected static final String GET = "GET";

    /**
     * The POST method.
     */
    protected static final String POST = "POST";

    /**
     * The MIME type.
     */
    protected String mimeType = "application/json";

    /**
     * Constructor.
     */

sources | indent 10 }} {{- end }} minio/templates/post-install-create-user-job.yaml {{- if .Values.users }} apiVersion: batch/v1 kind: Job metadata: name: {{ template "minio.fullname" . }}-make-user-job namespace: {{ .Release.Namespace | quote }} labels: app: {{ template "minio.name" . }}-make-user-job chart: {{ template "minio.chart" . }} release: {{ .Release.Name }} heritage: {{ .Release.Service }} annotations: "helm.sh/hook": post-install,post-upgrade "helm.sh/hook-delete-policy": hook-succee...

sources | indent 10 }} {{- end }} minio/templates/post-install-create-user-job.yaml {{- if .Values.users }} apiVersion: batch/v1 kind: Job metadata: name: {{ template "minio.fullname" . }}-make-user-job namespace: {{ .Release.Namespace | quote }} labels: app: {{ template "minio.name" . }}-make-user-job chart: {{ template "minio.chart" . }} release: {{ .Release.Name }} heritage: {{ .Release.Service }} annotations: "helm.sh/hook": post-install,post-upgrade "helm.sh/hook-delete-policy": hook-succee...

sources | indent 10 }} {{- end }} minio/templates/post-install-create-user-job.yaml {{- if .Values.users }} apiVersion: batch/v1 kind: Job metadata: name: {{ template "minio.fullname" . }}-make-user-job namespace: {{ .Release.Namespace | quote }} labels: app: {{ template "minio.name" . }}-make-user-job chart: {{ template "minio.chart" . }} release: {{ .Release.Name }} heritage: {{ .Release.Service }} annotations: "helm.sh/hook": post-install,post-upgrade "helm.sh/hook-delete-policy": hook-succee...

sources | indent 10 }} {{- end }} minio/templates/post-install-create-user-job.yaml {{- if .Values.users }} apiVersion: batch/v1 kind: Job metadata: name: {{ template "minio.fullname" . }}-make-user-job namespace: {{ .Release.Namespace | quote }} labels: app: {{ template "minio.name" . }}-make-user-job chart: {{ template "minio.chart" . }} release: {{ .Release.Name }} heritage: {{ .Release.Service }} annotations: "helm.sh/hook": post-install,post-upgrade "helm.sh/hook-delete-policy": hook-succee...

sources | indent 10 }} {{- end }} minio/templates/post-install-create-user-job.yaml {{- if .Values.users }} apiVersion: batch/v1 kind: Job metadata: name: {{ template "minio.fullname" . }}-make-user-job namespace: {{ .Release.Namespace | quote }} labels: app: {{ template "minio.name" . }}-make-user-job chart: {{ template "minio.chart" . }} release: {{ .Release.Name }} heritage: {{ .Release.Service }} annotations: "helm.sh/hook": post-install,post-upgrade "helm.sh/hook-delete-policy": hook-succee...

sources | indent 10 }} {{- end }} minio/templates/post-install-create-user-job.yaml {{- if .Values.users }} apiVersion: batch/v1 kind: Job metadata: name: {{ template "minio.fullname" . }}-make-user-job namespace: {{ .Release.Namespace | quote }} labels: app: {{ template "minio.name" . }}-make-user-job chart: {{ template "minio.chart" . }} release: {{ .Release.Name }} heritage: {{ .Release.Service }} annotations: "helm.sh/hook": post-install,post-upgrade "helm.sh/hook-delete-policy": hook-succee...

    }

    // POST /api/admin/elevateword/setting
    /**
     * Creates a new elevate word setting.
     * Also adds the elevate word to the suggest helper for search enhancement.
     *
     * @param body elevate word setting data to create
     * @return JSON response with created setting ID and status
     */
    @Execute
    public JsonResponse<ApiResult> post$setting(final CreateBody body) {