Skip to content

Latest commit

 

History

History
119 lines (92 loc) · 5.97 KB

README.pt-BR.md

File metadata and controls

119 lines (92 loc) · 5.97 KB

The Office API

image

Este é um .NET 7 Web API que fornece pontos finais para acessar e gerenciar dados relacionados ao programa de TV The Office.
A API permite que os usuários recuperem informações sobre personagens, episódios e citações do programa.

Documentação da API 📝

Os endpoints da API é documentada usando Swagger

Abra o navegador em http://localhost:5000/swagger. Isto exibirá a interface de usuário Swagger, que fornece uma interface amigável para explorar a API pontos finais. A API fornece os seguintes pontos finais:

  • GET /characters - retorna uma lista de personagens do The Office.
  • GET /characters/{id} - retorna um personagem específico por ID.
  • POST /character - adiciona um personagem novo no The Office.
  • DELETE /character - remove um personagem no The Office.
  • GET /episodes - retorna uma lista de episódios no The Office.
  • GET /episodes/{id} - retorna um episódio específico por ID.
  • POST /episode - aadiciona um episódio novo no The Office.
  • DELETE /episode - remove um episódio no The Office.
  • GET /seasons - retorna uma lista de temporadas do The Office.
  • GET /seasons/{id} - retorna uma temporada específica por ID.
  • POST /seasons - adiciona uma temporada nova no The Office.
  • DELETE /seasons - remove uma temporada no The Office.

  1. Presentation Layer
  • Nome: the-office.api
  • Descrição: Esta camada é responsável por expor os endpoinds da API para o mundo externo e receber requisições HTTP
    processar e retornar as respostas. Esta é nesta camada que a maioria das configurações API é feita.
  1. Application Layer
  • Nome: the-office.application
  • Descrição: A camada de aplicação é responsável por alojar as regras comerciais da aplicação,
    utiliza os serviços prestados pelas outras camadas para realizar as operações necessárias. Está nesta camada
    que os casos de uso da aplicação sejam implementados.
  1. Domain Layer
  • Nome: the-office.domain
  • Descrição: A aplicação é responsável pela definição dos conceitos e regras comerciais da aplicação.
    É nesta camada que são definidas as entidades e os valores dos objetos que a aplicação utiliza.
  1. Infrastructure Layer
  • Nome: the-office.infrastructure
  • Descrição: Esta camada é responsável pelo acesso a dados.
    Nesta camada contém configurações de conexões de banco, Migrations, Mappings, Repositories e configurações do MediatR.

image

Como começar 🚀

Para começar com a API, clone este repositório para sua máquina local e execute o seguinte
comando para iniciar a aplicação:

Para começar a utilizar o API, siga estes passos:

Instalação 🔧

  1. Install .NET 7 if you haven't already. You can download it from here.
  2. Clone o repositório para sua máquina local.https://github.com/JessicaNathany/the-office.api.git
  3. Próximo, navegue até o diretório do projeto e execute o seguinte comando para restaurar as dependências: dotnet restore
  4. Finalmente, execute o seguinte comando para iniciar a API: dotnet run
  5. O aplicativo começará a ouvir em http://localhost:5000

Recursos atuais 📋

  • GET /characters - retorna uma lista de personagens do The Office.
  • GET /characters/{id} - obtém personagens por ID.
  • GET /episodes - retorna uam lista de episódios do The Office.
  • GET /episodes/{id} - retorna um episódio específico por ID.
  • GET /quotes/characters/{id} - retorna frases específicas por id do ator do The Office

Próximos recursos 🎯

  • GET /gifs - retornar uma lista de Gifs do Office.
  • GET /images - retornar todas as imagens do The Office.
  • GET /images/character/{id} - retornar imagens do personagem do The Office.

Status do projeto Este projeto está atualmente na versão 1.0.0. Abaixo está uma lista das características atualmente disponíveis
e aquelas que irão ser adicionado em futuras atualizações.

Libraries and Backages 🛠️

🤝 Contribuições Contribuições são bem-vindas!
Para contribuir com este projeto, por favor, bifurque este repositório e apresente um pedido de puxar.

📄 Licença Este projeto está licenciado sob a Licença MIT - consulte o arquivo LICENSE.md para maiores detalhes..

📧 Contact Se você tiver alguma pergunta ou feedback sobre este projeto, sinta-se à vontade para nos contatar em [email protected]

atualizando...