> For the complete documentation index, see [llms.txt](https://bikeconecta.gitbook.io/api-bikeconecta/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bikeconecta.gitbook.io/api-bikeconecta/api-swagger-ui.md).

# API - Swagger UI

Utilize o swagger para interagir com a API

## Documentação Swagger da API Bikeconecta

### Visão Geral

Para explorar detalhadamente todos os endpoints disponíveis da nossa API, incluindo parâmetros, exemplos de solicitações e respostas, por favor, acesse a nossa documentação interativa do Swagger.

#### Acesse a Documentação Swagger

[Clique aqui para acessar a documentação Swagger](https://api.bikeconecta.com.br/swagger)

#### Benefícios da Documentação Swagger

* **Interativa**: Teste os endpoints diretamente na documentação.
* **Detalhada**: Veja descrições completas de cada endpoint, incluindo parâmetros obrigatórios e opcionais.
* **Exemplos**: Confira exemplos de solicitações e respostas para entender melhor como usar nossa API.
* **Exploração Rápida**: Navegue facilmente por todos os recursos e serviços oferecidos pela nossa API.

#### Como Utilizar

1. **Navegue pelo Menu**: Use o menu lateral para navegar pelos diferentes endpoints.
2. **Explore Endpoints**: Clique em qualquer endpoint para expandir e ver detalhes como descrições, parâmetros e exemplos de uso.
3. **Teste Solicitações**: Utilize a funcionalidade "Try it out" para fazer chamadas de teste diretamente da interface Swagger.

#### Autenticação com Bearer Token

Para autenticar suas solicitações, você precisa incluir o token de acesso no cabeçalho `Authorization`. É importante lembrar que o token deve ser precedido da palavra "Bearer", seguido de um espaço e do token.

**Exemplo de Cabeçalho de Autenticação**

```http
Authorization: Bearer SEU_TOKEN_DE_ACESSO
```