Creating TypeScript POST Controllers

TypeScript
export const createUserController = async (
  body: User.CreateUserParams,
): Promise<AxiosResponse<User.User, any>> => {
  const url = '/api/users/';
  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);
  }
};

Progress:

• Define function name (verb + resource + "Controller")
• Identify URL parameters (0 or more)
• Define body type
• Define response type
• Construct URL with parameters
• Implement error handling

Example 1: No URL parameters Input: POST /api/products/, body: Product.CreateParams, returns: Product.Product

TypeScript
export const createProductController = async (
  body: Product.CreateProductParams,
): Promise<AxiosResponse<Product.Product, any>> => {
  const url = '/api/products/';
  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: POST /api/projects/{projectId}/tasks/, body: Task.CreateParams, returns: Task.Task

TypeScript
export const createTaskController = async (
  projectId: Project.Project['id'],
  body: Task.CreateTaskParams,
): Promise<AxiosResponse<Task.Task, any>> => {
  const url = `/api/projects/${projectId}/tasks/`;
  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 3: Multiple parameters and union body type Input: POST /api/teams/{teamId}/members/{memberId}/roles/, body: Role.AssignParams | Role.UpdateParams, returns: Role.Assignment

TypeScript
export const createMemberRoleController = async (
  teamId: Team.Team['id'],
  memberId: Member.Member['id'],
  body: Role.AssignRoleParams | Role.UpdateRoleParams,
): Promise<AxiosResponse<Role.Assignment, any>> => {
  const url = `/api/teams/${teamId}/members/${memberId}/roles/`;
  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);
  }
};