การสร้างโค้ด OpenAPI: ชนิดที่สร้างโดยอัตโนมัติ

ยินดีต้อนรับ

เหตุผลที่ควรใช้ Codegen

openapi-typescript

npm install -D openapi-typescript
npx openapi-typescript ./api.yaml -o ./src/types/api.ts

ชนิดที่สร้างขึ้น

import type { paths } from './types/api';
type GetUserResponse = paths['/users/{id}']['get']['responses']['200']['content']['application/json'];

ไคลเอ็นต์ openapi-fetch

import createClient from 'openapi-fetch';
const client = createClient<paths>({ baseUrl: 'https://api.example.com' });
const { data, error } = await client.GET('/users/{id}', { params: { path: { id: 1 } } });

Swagger Codegen

npm install @openapitools/openapi-generator-cli -g
openapi-generator-cli generate -i api.yaml -g typescript-axios -o ./src/client

orval

npm install -D orval
orval --input api.yaml --output src/api

การทำให้ชนิดสอดคล้องกัน

การพัฒนา API โดยใช้สคีมาเป็นหลัก

MSW กับชนิดที่สร้างขึ้น

การสร้าง URL อย่างปลอดภัยตามชนิด

ตรวจสอบสั้น ๆ

สรุปทบทวน