{"id":18867191,"url":"https://github.com/daviteixeira-dev/restful","last_synced_at":"2026-02-13T10:30:17.726Z","repository":{"id":136315682,"uuid":"473585853","full_name":"daviteixeira-dev/Restful","owner":"daviteixeira-dev","description":null,"archived":false,"fork":false,"pushed_at":"2022-03-26T07:43:16.000Z","size":11,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-30T22:31:49.262Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/daviteixeira-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-24T11:56:40.000Z","updated_at":"2022-03-26T07:43:20.000Z","dependencies_parsed_at":null,"dependency_job_id":"6da07334-c261-4d3b-9f31-caafadbcb89d","html_url":"https://github.com/daviteixeira-dev/Restful","commit_stats":null,"previous_names":["daviteixeira-dev/restful"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daviteixeira-dev%2FRestful","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daviteixeira-dev%2FRestful/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daviteixeira-dev%2FRestful/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daviteixeira-dev%2FRestful/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/daviteixeira-dev","download_url":"https://codeload.github.com/daviteixeira-dev/Restful/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239816478,"owners_count":19701753,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T05:08:44.774Z","updated_at":"2026-02-13T10:30:17.675Z","avatar_url":"https://github.com/daviteixeira-dev.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# API, REST e RESTFUL\n\n## API\n\nCliente (Client)\nGarçom (pedidos, levar seus pedidos, para a cozinha) (API)\nCozinha (Server)\n\nAcrônimo de Application Programming Interface (Interface de Programação de Aplicações) é basicamente um conjunto de rotinas e padrões estabelecidos por uma aplicação, para que outras aplicações possam utilizar as funcionalidades desta aplicação.\n\n- Responsável por estabelecer comunicação entre diferentes serviços.\n- Meio de campo entre as tecnologias.\n- Intermediador para troca de informações.\n\n## REST\n\num acrônimo para REpresentational State Transfer (Transferência de Estado Representativo).\n\nSerá feita a transferência de dados de uma maneira simbólica, figurativa, representativa, de maneira didática.\n\nA transferência de dados, geralmente, usando o protocolo HTTP.\n\nO REST delimita algumas obrigações nessas transferências de dados.\n\nResources seria então: Uma entidade ou um objeto.\n\n### 6 NECESSIDADES (constraints) para ser RESTful\n\n- _Uniform Interface_: Manter uma uniformidade, uma constância, um padrão na construção da interface. Nossa API precisa ser coerente para quem vai consumi-lá. Precisa fazer sentido para o cliente e não ser confusa. Logo, coisas como: o uso correto dos verbos HTTP; endpoints coerentes (todos os endpoints no plural, por exemplo); usar somente uma linguagem de comunicação (json) e não várias ao mesmo tempo; sempre enviar respostas aos clientes; são exemplos de aplicação de uma interface uniforme.\n\n- _Client-server_: Separação do cliente e do armazenamento de dados (servidor), dessa forma, poderemos ter uma portabilidade do nosso sistema, usando o React para WEB e React Native para o smartphone, por exemplo.\n\n- _Stateless_: Cada requisição que o cliente faz para o servidor, deverá conter todas as informações necessárias para o servidor entender e responder (RESPONSE) a requisição (REQUEST). Exemplo: A sessão do usuário deverá ser enviada em todas as requisições, para saber se aquele usuário está autenticado e apto a usar os serviços, e o servidor não pode lembrar que o cliente foi autenticado na requisição anterior. Nos nossos cursos, temos por padrão usar tokens para as comunicações.\n\n- _Cacheable_: As respostas para uma requisição, deverão ser explicitas ao dizer se aquela resquição, pode ou não ser cacheada pelo cliente.\n\n- _Layered System_: O cliente acessa a um endpoint, sem precisar saber da complexidade, de quais passos estão sendo necessários para o servidor responder a requisição, ou quais outras camadas o servidor estará lidando, para que a requisição seja respondida.\n\n- _Code on demand (optional)_: Dá a possibilidade da nossa aplicação pegar códigos, como o javascript, por exemplo, e executar no cliente.\n\n## RESTFUL\n\nRESTful, é a aplicação dos padrões REST.\n\n## BOAS PRÁTICAS\n\n- Utilizar verbos HTTP para nossas requisições.\n- Utilizar plural ou singular na criação dos endpoints? _NÃO IMPORTA!_ use um padrão!!\n- Não deixar barra no final do endpoint\n- Nunca deixe o cliente sem resposta!\n\n### VERBOS HTTP\n\n- GET: Receber dados de um Resource.\n- POST: Enviar dados ou informações para serem processados por um Resource.\n- PUT: Atualizar dados de um Resource.\n- DELETE: Deletar um Resource\n\n### STATUS DAS RESPOSTAS\n\n- 1xx: Informação\n- 2xx: Sucesso\n  - 200: OK\n  - 201: CREATED\n  - 204: Não tem conteúdo PUT POST DELETE\n- 3xx: Redirection\n- 4xx: Client Error\n  - 400: Bad Request\n  - 404: Not Found!\n- 5xx: Server Error\n  500: Internal Server Error","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaviteixeira-dev%2Frestful","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdaviteixeira-dev%2Frestful","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaviteixeira-dev%2Frestful/lists"}