Building TypeScript API Controllers

TypeScript
export const getResourceController = async (
  id: string,
  qsParams: ResourceQueryParams,
): Promise<AxiosResponse<App.Pagination<Resource>, any>> => {
  const url = `/api/resource/${id}`;
  const instance = genRequestInstance();

  try {
    const response = await instance.get(url, { params: qsParams });
    return response;
  } catch (error) {
    console.error('Erro na requisição:', error);
    return Promise.reject(error);
  }
};

Progress:

• Define function signature with URL parameters first, then query string params
• Build URL path with required parameters embedded
• Create request instance
• Make request with query string as params object
• Handle errors with console.error and Promise.reject

Step-by-step Process:

1. Function signature: Required URL params first, then optional query string params
2. URL construction: Embed required parameters directly in URL path
3. Query string handling: Always use { params: qsParams } pattern
4. Error handling: Log error and reject promise

Example 1: With URL parameter

TypeScript
export const getUserPostsController = async (
  userId: string,
  qsParams: PostQueryParams,
): Promise<AxiosResponse<App.Pagination<Post>, any>> => {
  const url = `/api/user/${userId}/posts`;
  const instance = genRequestInstance();

  try {
    const response = await instance.get(url, { params: qsParams });
    return response;
  } catch (error) {
    console.error('Erro na requisição:', error);
    return Promise.reject(error);
  }
};

Example 2: Multiple URL parameters

TypeScript
export const getProjectTasksController = async (
  projectId: string,
  sprintId: string,
  qsParams: TaskQueryParams,
): Promise<AxiosResponse<App.Pagination<Task>, any>> => {
  const url = `/api/project/${projectId}/sprint/${sprintId}/tasks`;
  const instance = genRequestInstance();

  try {
    const response = await instance.get(url, { params: qsParams });
    return response;
  } catch (error) {
    console.error('Erro na requisição:', error);
    return Promise.reject(error);
  }
};

Example 3: No URL parameters

TypeScript
export const getAllUsersController = async (
  qsParams: UserQueryParams,
): Promise<AxiosResponse<App.Pagination<User>, any>> => {
  const url = `/api/users`;
  const instance = genRequestInstance();

  try {
    const response = await instance.get(url, { params: qsParams });
    return response;
  } catch (error) {
    console.error('Erro na requisição:', error);
    return Promise.reject(error);
  }
};