chore: openapi doc generator (#2644)

* chore: extract the type and comment from apis

* chore: template code

* feat: openapi

* pref: openapi generator. send into public/openapi folder
This commit is contained in:
Finley Ge
2024-09-09 15:43:09 +08:00
committed by GitHub
parent 5f3c8e9046
commit 78ad2791cd
12 changed files with 2214 additions and 24 deletions

View File

@@ -0,0 +1,40 @@
```ts
import type { ApiRequestProps, ApiResponseType } from '@fastgpt/service/type/next';
import { NextAPI } from '@/service/middleware/entry';
// This should be at the top of the file after the imports
export const ApiMetadata = {
name: 'template example api',
author: 'Finley',
version: '0.1.0',
}
export type TemplateQuery = {
// The App's ID
appId?: string[],
// The App's Name
name: string,
// The App's Description
description: string | Something<AppDetailType>,
};
export type TemplateBody = {
// The App's Name
name: string,
};
// This is the response type for the API
export type TemplateResponse = AppDetailType;
// This is the template API for FASTGPT NextAPI
async function handler(
req: ApiRequestProps<TemplateBody, TemplateQuery>,
res: ApiResponseType<any>,
): Promise<TemplateResponse> {
return {}
}
export default NextAPI(handler);
```