# Crie APIs RESTful robusta

As APIs devem seguir o padrão *Representational State Transfer* (REST), sempre que possível, utilizando o protocolo HTTP para manipulação de dados. Uma das vantagens do REST é que fornece uma estrutura para comunicar estados de erro. Utilize os HTTP Headers para passar informação adicional e os métodos GET, POST, PUT e DELETE, que indicam a ação a ser realizada.

* GET – recupera ou consulta um recurso;
* POST – cria um novo recurso ou inicia uma ação;
* PUT – atualiza ou substitui um recurso existente;
* DELETE – remover um recurso.

Os Uniform Resource Locators (URLs) devem representar apenas entidades e objetos de negócios e deve evitar-se a utilização de métodos de ação dentro da string do URL.

Use JSON sempre que possível em todas as APIs e documente o objeto JSON para garantir que esteja bem descrito e acessível a todos.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://guias.mosaico.gov.pt/guias-praticos/boas-praticas-para-a-publicacao-de-api-a-consumir-pela-administracao-publica/crie-apis-restful-robusta.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.