Skip to content

Commit

Permalink
docs: Add docs for fetch custom header
Browse files Browse the repository at this point in the history
  • Loading branch information
trandaison committed Jul 29, 2024
1 parent 5af577d commit abe0c8c
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 2 deletions.
16 changes: 15 additions & 1 deletion docs/api/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ The top level of the `auth` options in `nuxt.config.js` looks like this:
{
auth: {
endpoints: object,
headers: object,
token: object,
refreshToken: object,
redirect: object,
Expand All @@ -25,6 +26,12 @@ The top level of the `auth` options in `nuxt.config.js` looks like this:

An object containing information about the endpoints for authentication.

## `headers`

An object containing the headers to be sent with [`$fetch`](/api/$auth.html#fetch) requests.

This option is useful when you need to send headers with every request, for example, to send an client id, or to set the content type.

### `baseUrl`

```ts
Expand All @@ -40,6 +47,7 @@ login: {
url: '/login',
method: 'POST',
property: '',
headers: undefined,
}
```

Expand All @@ -48,6 +56,7 @@ An object containing information about the API login endpoint.
- `url`: Path of the API login.
- `method`: Method of the API login.
- `property`: The name of the property containing the response data from the API.
- `headers`: The headers to be sent with the login request.

For example, if your API login has a response object like this:

Expand All @@ -67,13 +76,14 @@ Then you need to set `property` to `data.tokens`.
### `logout`

```ts
logout: { url: '/logout', method: 'DELETE' }
logout: { url: '/logout', method: 'DELETE', headers: undefined }
```

An object containing information about the API logout endpoint.

- `url`: Path of the API logout.
- `method`: Method of the API logout.
- `headers`: The headers to be sent with the logout request.

### `refresh`

Expand All @@ -82,6 +92,7 @@ refresh: {
url: '/refresh_tokens',
method: 'POST',
property: '',
headers: undefined
}
```

Expand All @@ -90,6 +101,7 @@ An object containing information about the API refresh token endpoint.
- `url`: Path of the API refresh token.
- `method`: Method of the API refresh token.
- `property`: The name of the property containing the response data from the API.
- `headers`: The headers to be sent with the refresh token request.

For example, if your API refresh tokens have a response object like this:

Expand All @@ -113,6 +125,7 @@ user: {
url: '/me',
method: 'GET',
property: '',
headers: undefined
}
```

Expand All @@ -121,6 +134,7 @@ An object containing information about the API fetch user info endpoint.
- `url`: Path of the API fetch user info.
- `method`: Method of the API fetch user info.
- `property`: The name of the property containing the response data from the API.
- `headers`: The headers to be sent with the fetch user info request.

For example, if your API fetch user info has a response object like this:

Expand Down
16 changes: 15 additions & 1 deletion docs/vi/api/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Top level của `auth` options trong `nuxt.config.js` như sau:
{
auth: {
endpoints: object,
headers: object,
token: object,
refreshToken: object,
redirect: object,
Expand All @@ -25,6 +26,12 @@ Top level của `auth` options trong `nuxt.config.js` như sau:

object chứa thông tin các endpoint cho việc authen.

## `headers`

Object chứa các headers sẽ được gửi cùng với các request được tạo ra bởi [`$fetch`](/api/$auth.html#fetch).

Option này sẽ hữu ích khi bạn cần gửi custom header trong mọi request, ví dụ như gửi client id, hoặc set content type.

### `baseUrl`

```ts
Expand All @@ -40,6 +47,7 @@ login: {
url: '/login',
method: 'POST',
property: '',
headers: undefined,
}
```

Expand All @@ -48,6 +56,7 @@ Object chứa thông tin của endpoint api login.
- `url`: Path của API login.
- `method`: Phương thức của API login.
- `property`: Tên thuộc tính chứa data response từ API.
- `headers`: Các headers sẽ được gửi cùng với request login.

Ví dụ API login của bạn có object response như sau:

Expand All @@ -67,13 +76,14 @@ Thì bạn cần set `property` là `data.tokens`.
### `logout`

```ts
logout: { url: '/logout', method: 'DELETE' }
logout: { url: '/logout', method: 'DELETE', headers: undefined }
```

Object chứa thông tin của endpoint api logout.

- `url`: Path của API logout.
- `method`: Phương thức của API logout.
- `headers`: Các headers sẽ được gửi cùng với request logout.

### `refresh`

Expand All @@ -82,6 +92,7 @@ refresh: {
url: '/refresh_tokens',
method: 'POST',
property: '',
headers: undefined,
}
```

Expand All @@ -90,6 +101,7 @@ Object chứa thông tin của endpoint api refresh token.
- `url`: Path của API refresh token.
- `method`: Phương thức của API refresh token.
- `property`: Tên thuộc tính chứa data response từ API.
- `headers`: Các headers sẽ được gửi cùng với request refresh token.

Ví dụ API refresh tokens của bạn có object response như sau:

Expand All @@ -113,6 +125,7 @@ user: {
url: '/me',
method: 'GET',
property: '',
headers: undefined,
}
```

Expand All @@ -121,6 +134,7 @@ Object chứa thông tin của endpoint api fetch user info.
- `url`: Path của API fetch user info.
- `method`: Phương thức của API fetch user info.
- `property`: Tên thuộc tính chứa data response từ API.
- `headers`: Các headers sẽ được gửi cùng với request fetch user info.

Ví dụ API fetch user info của bạn có object response như sau:

Expand Down

0 comments on commit abe0c8c

Please sign in to comment.