> For the complete documentation index, see [llms.txt](https://hacking-notes.jord4n.pro/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hacking-notes.jord4n.pro/pt-br/web/api-testing/operating-an-endpoint-using-documentation.md).
# Operação de um endpoint usando documentação
Operando um endpoint explorando um endpoint usando documentação anotações para os laboratórios da PortSwigger Web Security Academy, incluindo fluxo de exploração, testes de payloads, validação no Burp Suite e remediaç
### Explorando um endpoint de API usando a documentação
**Objetivo do laboratório**
O objetivo deste laboratório é localizar a documentação exposta da API e então usar um endpoint para remover o usuário **carlos**. / Uma conta válida é fornecida para testes:
* **Credenciais**: `wiener:peter`
**Descoberta da documentação da API**
Explorar a aplicação identifica uma rota que leva a um **REST API** que contém sua documentação. / Essa documentação descreve claramente os endpoints disponíveis e até fornece exemplos de requisições prontas para uso, inclusive na forma de **curl** comandos.
**Recuperação de informações do usuário**
A partir da documentação, observa-se que um endpoint permite recuperar informações de um usuário especificando seu nome. / A requisição fornecida retorna dados do usuário **carlos**:
* Requisição:
* Método: `GET`
* Endpoint: `/api/user/carlos`
{% code overflow="wrap" %}
```bash
curl -vgw "/n" -X GET 'https://0a73004e0348a82c81d3ca78004c00f7.web-security-academy.net/api/user/carlos'
```
{% endcode %}
* Resposta:
* O servidor retorna um objeto JSON contendo o nome de usuário e o endereço de e-mail.
```json
{
"username": "carlos",
"email": "carlos@carlos-montoya.net"
}
```
**Exclusão do usuário carlos**
A documentação também indica que é possível excluir um usuário por meio de uma requisição dedicada. / Usando o endpoint correspondente com o método apropriado:
* Requisição:
* Método: `DELETE`
* Endpoint: `/api/user/carlos`
{% code overflow="wrap" %}
```bash
curl -vgw "/n" -X DELETE 'https://0a73004e0348a82c81d3ca78004c00f7.web-security-academy.net/api/user/carlos' -d '{}'
```
{% endcode %}
* Resultado:
* O servidor aceita a requisição e retorna uma mensagem confirmando a remoção do usuário.
```json
{
"status": "Usuário excluído"
}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://hacking-notes.jord4n.pro/pt-br/web/api-testing/operating-an-endpoint-using-documentation.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
