name: fill-api description: Implement or complete API request functions from design docs and TODO markers, aligning fields and types with shared generated types. Use when user needs to implement API request functions, code contains TODO markers for API calls, or asks to fill in/create API functions.
Fill API
Goal
Complete API call implementations based on design docs and TODO markers.
Input
- Design doc path (markdown) with API descriptions.
Workflow
- Read the design doc and extract required endpoints.
- Locate TODO API stubs in code.
- Create or update modules under
src/request/api/. - Import shared types from
src/shared/. - Align request/response fields with API naming.
- Report updated files and remaining gaps.
Request Pattern
import { get, post } from '@/request/axios'
import type { GetUsersRequest, GetUsersResponse } from '@/shared/users'
export const getUserList = async (params?: GetUsersRequest) => {
return get<GetUsersRequest, GetUsersResponse>('/api/users/list', { params })
}
Response Handling
const [data, error] = await getUserList({ page: 1, pageSize: 10 })
if (error) {
return
}
console.log(data.data.list)