National_Parks_API

API de banco de dados de parques nacionais (aplicativo C# ASP .NET)

Por Krista Rutz

Uma aplicação API onde o usuário pode obter e postar informações sobre parques nacionais, hospedada no GitHub. Última atualização em 04.03.2020.

Descrição

Este aplicativo permite ao usuário criar entradas de banco de dados sobre parques nacionais, permitindo adicionar nomes, estados, códigos de parques, regiões, URLs de sites e uma nota sobre se o parque está aberto ou não. A capacidade de obter e postar parques está incluída, além da funcionalidade de colocar e excluir.

Este projeto foi desenvolvido em C# na plataforma .NET Core com processamento web ASP.NET Core, utilizando bibliotecas de padrões MVC e banco de dados SQL. Especificamente, o aplicativo foi desenvolvido usando Entity Framework e MySQL para criar o esquema e está hospedado no GitHub.

Foi criado para o projeto independente sexta-feira da semana 13 do Epicodus, na semana 6 do curso C# e .NET: "Construindo uma API".

Habilidades de Épicodo:

• C#
• Padrão MVC (com ASP .NET Core 2.2)
• Roteamento RESTful e CRUD
• Migrações de estrutura de entidade
• Ambiente de trabalho MySQL e servidor
• Desenvolvimento orientado por comportamento (BDD)
• Controle de versão Git e GitHub
• Construção de API RESTful

Instalação / Configuração

Esta API está totalmente documentada. Encontre uso e explicações no documento Documentação da API.

Baixe ou clone o repositório para executar este programa localmente!

Este programa requer o SDK do .NET Core para ser executado. Aqui está um tutorial gratuito para instalar o .NET no Mac ou Windows 10.

Este programa também utiliza bancos de dados SQL. Recomendamos usar MySQL Workbench para construir seus bancos de dados. Aqui está um tutorial gratuito para instalar o MySQL WorkBench e o MySQL Community Server no Mac ou Windows 10.

• Baixe ou clone este repositório.
  • Para baixar ZIP:
    • Selecione "Download" no site do repositório GitHub
    • Depois de baixado, abra o ZIP e extraia os arquivos. A nova pasta será criada como 'Week-13-Building-an-API-C-Sharp'.
  • Para clonar:
    • Clone da linha de comando em sua área de trabalho: $ git clone https://github.com/KristaRutz/Week-13-Building-an-API-C-Sharp
    • O novo diretório será criado como 'Desktop/Week-12-Advanced-Databases-and-Authentication-Project'.
• Depois de armazenar os arquivos localmente, execute os seguintes comandos.
  • Navegue até o diretório do aplicativo: $ cd Desktop/Week-13-Building-an-API-C-Sharp/NationalParkDirectoryApi
  • $ dotnet restore
  • $ dotnet ef database update
  • $ dotnet build
  • $ dotnet run
• Após sucesso, o programa começará a ser executado em seu console.

Tecnologias Utilizadas

• .NET Core 2.2
  • Lado do servidor em C#
• Banco de dados MySQL
• Carteiro

Especificações

Crie uma API para parques estaduais e nacionais. A API listará os parques estaduais e nacionais. Aqui estão os recursos a serem incluídos:

• O aplicativo inclui funcionalidade CRUD e retorna respostas às chamadas de API com sucesso.
• A aplicação inclui pelo menos um dos objetivos de exploração adicionais: autenticação, controle de versão, paginação, documentação Swagger ou CORS.
• A aplicação está bem documentada, incluindo documentação específica sobre exploração adicional.
• Depois de concluir os requisitos para a revisão do código, considere adicionar outras funcionalidades da Exploração Adicional de segunda-feira. Seja criativo e adicione outras rotas, escopos e funcionalidades personalizadas também. Aqui estão algumas outras possibilidades a serem consideradas:
  • Adicione um endpoint RANDOM que retorne aleatoriamente um parque.
  • Adicione um segundo endpoint personalizado que aceite parâmetros. Exemplo: uma rota SEARCH que permite aos usuários pesquisar por nomes de parques específicos.

Seu código será revisado para os seguintes objetivos:

• O aplicativo inclui funcionalidade CRUD e retorna respostas às chamadas de API com êxito.

• A aplicação inclui pelo menos um dos objetivos de exploração adicionais: autenticação, controle de versão, paginação, documentação Swagger ou CORS.

• A aplicação está bem documentada, incluindo documentação específica sobre exploração adicional.

• O histórico de commits mostra claramente oito horas de trabalho.

Erros conhecidos

• Nenhum bug conhecido

Detalhes de suporte e contato

Entre em contato comigo se tiver algum problema ou tiver dúvidas, ideias ou preocupações. Posso ser contatado em [email protected]. Sinta-se à vontade para criar uma solicitação pull para atualizações - contribuições para o código são incentivadas!

Licença

Direitos autorais (c) 2020 Krista Rutz

Este software está licenciado sob a licença MIT.

Ver detalhes da licença

É concedida permissão, gratuitamente, a qualquer pessoa que obtenha uma cópia deste software e dos arquivos de documentação associados (o "Software"), para negociar o Software sem restrições, incluindo, sem limitação, os direitos de usar, copiar, modificar, mesclar , publicar, distribuir, sublicenciar e/ou vender cópias do Software e permitir que as pessoas a quem o Software seja fornecido o façam, sujeito às seguintes condições:

O aviso de direitos autorais acima e este aviso de permissão serão incluídos em todas as cópias ou partes substanciais do Software.

O SOFTWARE É FORNECIDO "COMO ESTÁ", SEM GARANTIA DE QUALQUER TIPO, EXPRESSA OU IMPLÍCITA, INCLUINDO, MAS NÃO SE LIMITANDO ÀS GARANTIAS DE COMERCIALIZAÇÃO, ADEQUAÇÃO A UM DETERMINADO FIM E NÃO VIOLAÇÃO. EM HIPÓTESE ALGUMA OS AUTORES OU DETENTORES DE DIREITOS AUTORAIS SERÃO RESPONSÁVEIS POR QUALQUER RECLAMAÇÃO, DANOS OU OUTRA RESPONSABILIDADE, SEJA EM UMA AÇÃO DE CONTRATO, ATO ILÍCITO OU DE OUTRA FORMA, DECORRENTE DE, OU EM CONEXÃO COM O SOFTWARE OU O USO OU OUTRAS NEGOCIAÇÕES NO SOFTWARE.