National_Parks_API

API de base de datos de parques nacionales (aplicación C# ASP .NET)

Por Krista Rutz

Una aplicación API donde el usuario puede obtener y publicar información sobre parques nacionales, alojada en GitHub. Última actualización 04.03.2020.

Descripción

Esta aplicación permite al usuario crear entradas de bases de datos sobre parques nacionales, permitiéndole agregar nombres, estados, códigos de parques, regiones, URL de sitios web y una nota sobre si el parque está abierto o no. Se incluye la capacidad de obtener y publicar parques, además de la funcionalidad de colocar y eliminar.

Este proyecto fue desarrollado en C# sobre la plataforma .NET Core con procesamiento web ASP.NET Core, utilizando bibliotecas de patrones MVC y una base de datos SQL. Específicamente, la aplicación se creó utilizando Entity Framework y MySQL para crear el esquema y está alojada en GitHub.

Fue creado para el proyecto independiente del viernes de la semana 13 de Epicodus, en la semana 6 del curso de C# y .NET: "Construyendo una API".

Habilidades de Epicodus:

• DO#
• Patrón MVC (con ASP .NET Core 2.2)
• Enrutamiento RESTful y CRUD
• Migraciones de marco de entidad
• Banco de trabajo y servidor MySQL
• Desarrollo impulsado por el comportamiento (BDD)
• Control de versiones de Git y GitHub
• Construcción de API RESTful

Instalación / Configuración

Esta API está completamente documentada. Encuentre el uso y las explicaciones en el documento de documentación de API.

¡Descarga o clona el repositorio para ejecutar este programa localmente!

Este programa requiere .NET Core SDK para ejecutarse. Aquí hay un tutorial gratuito para instalar .NET en Mac o Windows 10.

Este programa también hace uso de bases de datos SQL. Recomendamos utilizar MySQL Workbench para crear sus bases de datos. Aquí hay un tutorial gratuito para instalar MySQL WorkBench y MySQL Community Server en Mac o Windows 10.

• Descargue o clone este repositorio.
  • Para descargar ZIP:
    • Seleccione "Descargar" en el sitio del repositorio de GitHub.
    • Una vez descargado, abra el ZIP y extraiga los archivos. La nueva carpeta se creará como 'Semana-13-Construyendo-una-API-C-Sharp'.
  • Para clonar:
    • Clona desde la línea de comando a tu escritorio: $ git clone https://github.com/KristaRutz/Week-13-Building-an-API-C-Sharp
    • El nuevo directorio se creará como 'Desktop/Week-12-Advanced-Databases-and-Authentication-Project'.
• Una vez que haya almacenado los archivos localmente, ejecute los siguientes comandos.
  • Navegue hasta el directorio de la aplicación: $ cd Desktop/Week-13-Building-an-API-C-Sharp/NationalParkDirectoryApi
  • $ dotnet restore
  • dotnet ef database update
  • $ dotnet build
  • $ dotnet run
• Si tiene éxito, el programa comenzará a ejecutarse en su consola.

Tecnologías utilizadas

• .NET Core 2.2
  • Del lado del servidor en C#
• base de datos mysql
• Cartero

Especificaciones

Crear una API para parques estatales y nacionales. La API enumerará los parques estatales y nacionales. Estas son las características que se deben incluir:

• La aplicación incluye funcionalidad CRUD y devuelve con éxito respuestas a llamadas API.
• La aplicación incluye al menos uno de los objetivos de exploración adicionales: autenticación, control de versiones, paginación, documentación Swagger o CORS.
• La solicitud está bien documentada, incluida documentación específica sobre exploración adicional.
• Una vez que complete los requisitos para la revisión del código, considere agregar otras funciones de la Exploración adicional del lunes. Sea creativo y agregue también otras rutas, alcances y funcionalidades personalizados. Aquí hay algunas otras posibilidades a considerar:
  • Agregue un punto final RANDOM que devuelva aleatoriamente un parque.
  • Agregue un segundo punto final personalizado que acepte parámetros. Ejemplo: una ruta de BÚSQUEDA que permite a los usuarios buscar por nombres de parques específicos.

Su código será revisado para los siguientes objetivos:

• La aplicación incluye funcionalidad CRUD y devuelve con éxito respuestas a llamadas API.

• La aplicación incluye al menos uno de los objetivos de exploración adicionales: autenticación, control de versiones, paginación, documentación Swagger o CORS.

• La solicitud está bien documentada, incluida documentación específica sobre exploración adicional.

• El historial de confirmaciones muestra claramente ocho horas de trabajo.

Errores conocidos

• No hay errores conocidos

Detalles de soporte y contacto

Comuníquese conmigo si tiene algún problema o tiene preguntas, ideas o inquietudes. Me pueden contactar en [email protected]. No dudes en crear una solicitud de extracción para obtener actualizaciones: ¡se recomiendan contribuciones al código!

Licencia

Copyright (c) 2020 Krista Rutz

Este software tiene la licencia MIT.

Ver detalles de la licencia

Por el presente se otorga permiso, sin cargo, a cualquier persona que obtenga una copia de este software y los archivos de documentación asociados (el "Software"), para operar con el Software sin restricciones, incluidos, entre otros, los derechos de uso, copia, modificación, fusión. , publicar, distribuir, sublicenciar y/o vender copias del Software, y permitir que las personas a quienes se les proporciona el Software lo hagan, sujeto a las siguientes condiciones:

El aviso de derechos de autor anterior y este aviso de permiso se incluirán en todas las copias o partes sustanciales del Software.

EL SOFTWARE SE PROPORCIONA "TAL CUAL", SIN GARANTÍA DE NINGÚN TIPO, EXPRESA O IMPLÍCITA, INCLUYENDO, PERO NO LIMITADO A, LAS GARANTÍAS DE COMERCIABILIDAD, IDONEIDAD PARA UN PROPÓSITO PARTICULAR Y NO INFRACCIÓN. EN NINGÚN CASO LOS AUTORES O TITULARES DE DERECHOS DE AUTOR SERÁN RESPONSABLES DE NINGÚN RECLAMO, DAÑO U OTRA RESPONSABILIDAD, YA SEA EN UNA ACCIÓN CONTRACTUAL, AGRAVIO O DE OTRA MANERA, QUE SURJA DE, FUERA DE O EN RELACIÓN CON EL SOFTWARE O EL USO U OTRAS NEGOCIOS EN EL SOFTWARE.