مستندات API (Swagger / OpenAPI)

فینچ یک سیستم مستندسازی OpenAPI داخلی دارد. هر مسیر API را با استفاده از ApiDoc توصیف می‌کنید و فینچ یک OpenAPI JSON spec قابل‌خوانش برای ماشین و یک Swagger UI تولید می‌کند که به توسعه‌دهنده‌ها امکان می‌دهد API شما را از داخل مرورگر بررسی و تست کنند.

راه‌اندازی مستندات API به سه مرحله نیاز دارد:

یک نمونه از ApiController بسازید.
مسیرهای مستندسازی را ثبت کنید (خروجی JSON اوپن‌ای‌پی‌آی و Swagger UI).
اشیاء ApiDoc را به مسیرهایی که باید در مستندات نمایش داده شوند متصل کنید.

مرحله ۱ — ساخت ApiController

ApiController تمام مسیرهای اپلیکیشن شما را می‌خواند و OpenAPI spec را تولید می‌کند:

final apiController = ApiController(
  title: 'My App API',
  app: app,
);

مرحله ۲ — ثبت مسیرهای مستندسازی

دو مسیر به router خود اضافه کنید: یکی برای خروجی خام JSON اوپن‌ای‌پی‌آی و دیگری برای Swagger UI:

[
  // OpenAPI JSON spec را برمی‌گرداند — توسط Swagger UI و کلاینت‌های API استفاده می‌شود
  FinchRoute(
    key: 'root.api.docs',
    path: 'api/docs',
    index: apiController.indexPublic,
  ),

  // صفحه Swagger UI — آدرس JSON spec را پاس بدهید
  FinchRoute(
    key: 'root.swagger',
    path: 'swagger',
    index: () => apiController.swagger(rq.url('api/docs')),
  ),
];

مسیر /swagger را در مرورگر خود باز کنید تا مستندات تعاملی را ببینید.

به‌صورت پیش‌فرض، Swagger UI فقط در حالت local debug (isLocalDebug: true) در دسترس است. برای عمومی کردن آن، مقدار showPublic: true را به apiController.swagger(..., showPublic: true) پاس دهید.

مرحله ۳ — تعریف ApiDoc برای مسیرها

هر مسیر می‌تواند یک ApiDoc داشته باشد که توضیح می‌دهد آن مسیر چه کاری انجام می‌دهد، چه پارامترهایی می‌پذیرد و چه پاسخ‌هایی برمی‌گرداند. آن را از طریق ویژگی apiDoc به یک FinchRoute متصل کنید.

FinchRoute(
  key: 'api.books.list',
  path: 'api/books',
  methods: Methods.ONLY_GET,
  index: booksController.list,
  apiDoc: ApiDoc(
    get: ApiDoc(
      description: 'Returns a paginated list of books.',
      parameters: [
        ApiParameter<int>(
          'page',
          isRequired: false,
          paramIn: ParamIn.query,
          def: 1,
        ),
        ApiParameter<int>(
          'limit',
          isRequired: false,
          paramIn: ParamIn.query,
          def: 20,
        ),
      ],
      response: {
        '200': [
          ApiResponse<int>('count', def: 0),
          ApiResponse<List>('rows', def: []),
        ],
        '401': r_401,
        '404': r_404,
      },
    ),
  ),
),

ویژگی‌های ApiDoc

ApiDoc می‌تواند در سطح مسیر یا برای هر متد HTTP به‌کار رود. برای هر متد یک ApiDoc داخلی را nest کنید:

ApiDoc(
  get:    ApiDoc(description: '...', parameters: [...], response: {...}),
  post:   ApiDoc(description: '...', parameters: [...], response: {...}),
  put:    ApiDoc(description: '...', parameters: [...], response: {...}),
  delete: ApiDoc(description: '...', parameters: [...], response: {...}),
)

ApiParameter

ApiParameter<T> یک پارامتر ورودی را توصیف می‌کند:

ویژگی	نوع	توضیح
آرگومان اول	`String`	نام پارامتر
`isRequired`	`bool`	آیا این فیلد اجباری است
`paramIn`	`ParamIn`	مقدار از کجا می‌آید
`def`	`T?`	مقدار پیش‌فرض نمونه

مقادیر ParamIn:

مقدار	توضیح
`ParamIn.path`	بخش path در URL (مثال: `/books/{id}`)
`ParamIn.query`	رشته query (مثال: `?page=1`)
`ParamIn.header`	هدر درخواست HTTP
`ParamIn.body`	بدنه درخواست (POST/PUT)

ApiResponse

ApiResponse<T> یک فیلد در بدنه پاسخ را توصیف می‌کند:

ApiResponse<String>('title', def: 'Book Title'),
ApiResponse<int>('id', def: 0),
ApiResponse<bool>('success', def: true),
ApiResponse<Map<String, dynamic>>('data', def: {}),

میانبرهای پاسخ از پیش‌تعریف‌شده

فینچ لیست‌های پاسخ آماده برای کدهای خطای HTTP رایج فراهم می‌کند:

// در نگاشت response خود استفاده کنید:
response: {
  '200': [...],
  '401': r_401,  // Unauthorized
  '404': r_404,  // Not found
  '500': r_500,  // Server error
}

نمونه کامل یک مسیر

FinchRoute(
  key: 'api.books.one',
  path: 'api/books/{id}',
  methods: Methods.GET_POST,
  index: booksController.one,
  apiDoc: ApiDoc(
    get: ApiDoc(
      description: 'Get a single book by ID.',
      parameters: [
        ApiParameter<String>('id', isRequired: true, paramIn: ParamIn.path),
      ],
      response: {
        '200': [
          ApiResponse<int>('id', def: 0),
          ApiResponse<String>('title', def: ''),
          ApiResponse<String>('author', def: ''),
        ],
        '404': r_404,
      },
    ),
    post: ApiDoc(
      description: 'Update a book by ID.',
      parameters: [
        ApiParameter<String>('id', isRequired: true, paramIn: ParamIn.path),
        ApiParameter<String>('title', isRequired: false, paramIn: ParamIn.body),
        ApiParameter<String>('author', isRequired: false, paramIn: ParamIn.body),
      ],
      response: {
        '200': [ApiResponse<bool>('success', def: true)],
        '404': r_404,
      },
    ),
  ),
),

کنترلر مستندات API

final apiController = ApiController(
   title: "API Documentation",
   app: app,
);

// مسیرهایی که باید به routing اپ فینچ شما اضافه شوند
// خروجی JSON اوپن‌ای‌پی‌آی
FinchRoute(
    key: 'root.api.docs',
    path: 'api/docs',
    index: apiController.indexPublic,
),
// Swagger UI
FinchRoute(
    key: 'root.swagger',
    path: 'swagger',
    index: () => apiController.swagger(rq.url('api/docs')),
),

تعریف ApiDoc برای هر مسیر

class ApiDocuments {
    static Future<ApiDoc> onePerson() async {
    return ApiDoc(
      post: ApiDoc(
        response: {
          '200': [
            ApiResponse<int>('timestamp_start', def: 0),
            ApiResponse<bool>('success', def: true),
            ApiResponse<Map<String, String>>(
              'data',
              def: PersonCollectionFree.formPerson.fields.map((k, v) {
                return MapEntry(k, v.defaultValue?.call());
              }),
            ),
          ],
          '404': r_404,
        },
        description: "Update one person by id.",
        parameters: [
          ApiParameter<String>(
            'id',
            isRequired: true,
            paramIn: ParamIn.path,
          ),
          ApiParameter<String>(
            'name',
            isRequired: false,
            paramIn: ParamIn.header,
          ),
          ApiParameter<int>(
            'age',
            isRequired: false,
            paramIn: ParamIn.header,
          ),
          ApiParameter<double>(
            'height',
            isRequired: false,
            paramIn: ParamIn.header,
          ),
          ApiParameter<String>(
            'email',
            isRequired: true,
            paramIn: ParamIn.header,
          ),
          ApiParameter<String>(
            'married',
            isRequired: false,
            paramIn: ParamIn.header,
            def: false,
          ),
        ],
      ),
      get: ApiDoc(
        response: {
          '200': [
            ApiResponse<int>('timestamp_start', def: 0),
            ApiResponse<Map<String, String>>(
              'data',
              def: PersonCollectionFree.formPerson.fields.map((k, v) {
                return MapEntry(k, v.defaultValue?.call());
              }),
            ),
          ],
          '404': r_404,
        },
        description: "Get one person by id.",
        parameters: [
          ApiParameter<String>('id', isRequired: true, paramIn: ParamIn.path),
        ],
      ),
      delete: ApiDoc(
        response: {
          '200': [
            ApiResponse<int>('timestamp_start', def: 0),
            ApiResponse<bool>('success', def: true),
          ],
          '404': r_404,
        },
        description: "Delete one person by id.",
        parameters: [
          ApiParameter<String>('id', isRequired: true, paramIn: ParamIn.path),
        ],
      ),
    );
  }
}

/// نمونه‌ای برای افزودن ApiDoc به مسیرها
FinchRoute(
  key: 'root.person.show',
  path: 'api/person/{id}',
  extraPath: ['example/person/{id}'],
  index: homeController.onePerson,
  methods: Methods.GET_POST,
  apiDoc: ApiDocuments.onePerson,
),

در این صفحه