> For the complete documentation index, see [llms.txt](https://toktokhan.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://toktokhan.gitbook.io/docs/basic-guides/convention/apis/structure.md).

# Structure

apis 폴더의 구조입니다.

**`apis`** 폴더의 파일들은 보통 **`tokript`**의 **`gen:api`** 를 사용하면  [Swagger 의 Tag](https://swagger.io/docs/specification/grouping-operations-with-tags/) 를 기준으로 자동으로 생성됩니다

그러나 외부 프로젝트 처럼 **`gen:api`** 의 **사용이 제한되거나** 생성된 코드들을 수정하는 상황에서는 **`apis`** **폴더 구조와 사용법에 대한 이해가 꼭 필요**합니다.

<figure><img src="https://1168173052-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9A2Jt7XcUkiyMXRHBecz%2Fuploads%2F2O0zqg2LZkXYkYhe4xYd%2Fapi%20structure.png?alt=media&amp;token=3484c554-fa6b-4627-ae18-858c89e802ef" alt=""><figcaption></figcaption></figure>

### [1. type](https://toktokhan.gitbook.io/docs/basic-guides/convention/apis/pages/O1EX3Tud3l83LUL7i5bA#1.-type)

해당 api에서 사용 되는 reqeust / response 타입을 관리하는 폴더입니다.

### [2. Axios Api](broken://spaces/u1XINYTD2dfOMGJ7rW39)

config 폴더에서 설정한 axios를 바탕으로 생성되는 api 파일입니다.

### [3. React Query](https://toktokhan.gitbook.io/docs/basic-guides/convention/apis/pages/O1EX3Tud3l83LUL7i5bA#3.-react-query)

Axios api 생성한 api 파일을 사용하여 생성한 **React Query Custom Hooks** 파일입니다.

처음 보면 구조가 까다로울 수 있으니 꼭 Code Style을 참고해주세요.