Generating TypeScript REST API

Progress:

• Collect function requirements
• Generate main controller function with JSDoc
• Generate unit tests
• Add error handling patterns
• Validate TypeScript types

Step-by-step Process:

1. Analyze parameters - Determine if URL params needed
2. Structure function signature - Single params object if URL params exist
3. Build URL path - Template literals for dynamic segments
4. Add error handling - Try-catch with proper error propagation
5. Generate tests - Success and error scenarios
6. Add JSDoc - Complete documentation

Example 1: No URL Parameters Input:

• Name: "createArea"
• URL params: (none)
• Body: CreateAreaParams
• Return: Area

Output:

TypeScript
/**
 * Creates a new area
 * @param body - Area creation parameters
 * @returns Promise with area creation response
 * @throws {Error} When request fails
 */
export const createAreaController = async (
  body: Planejamento.Cadastro.Area.CreateAreaParams,
): Promise<AxiosResponse<Planejamento.Cadastro.Area.Area, any>> => {
  const url = '/api/planejamento/area/';
  const instance = genRequestInstance();
  try {
    const response = await instance.post(url, body);
    return response;
  } catch (error) {
    console.error('Erro na requisição:', error);
    return Promise.reject(error);
  }
};

Example 2: With URL Parameters Input:

• Name: "createColaboradorVaga"
• URL params: versao: string
• Body: CreateColaboradorVagaParams
• Return: any

Output:

TypeScript
/**
 * Creates a new colaborador vaga for specific version
 * @param params - URL parameters containing version ID
 * @param body - Colaborador vaga creation parameters
 * @returns Promise with creation response
 * @throws {Error} When request fails
 */
export const createColaboradorVagaController = async (
  params: { versao: Planejamento.Versao.Versao['id'] },
  body: Pessoal.Colaborador.Vaga.CreateColaboradorVagaParams,
): Promise<AxiosResponse<any, any>> => {
  const url = `/api/pessoal/versao/${params.versao}/colaborador-vaga/`;
  const instance = genRequestInstance();
  try {
    const response = await instance.post(url, body);
    return response;
  } catch (error) {
    console.error('Erro na requisição:', error);
    return Promise.reject(error);
  }
};