Net Core API
Por que usar API
Los usuarios cada vez utilizan más dispositivos diferentes, por lo cual una API es una solución, ya que podremos tener acceso a los datos desde diferentes tipos de aplicaciones gracias a la API.
Estas aplicaciones pedirás información a la API y esta será la encargada de devolverla en formato JSON.
Crear una API
Para trabajar con APIs tendremos que crearnos un proyecto del tipo: ASP .NET Core Web API que trabaje con C#.
Una vez tengamos el proyecto creado, tendremos que crearnos tres carpetas.
- Models
- Crearemos tantos modelos como nuestra base de datos o nuestro cliente requiera, con el tipo de datos que sean necesarios.
- Interface
- Por convención al crear una interface, empezará con «I» para que sepamos sin entrar en el fichero que es una Interface.
- En el fichero crearemos los métodos que vayamos a utilizar, pero sin ningún tipo de código, ya que de esto se encargará el repository.
- Repository
- Este será el fichero encargado de determinar que hace cada uno de los métodos que hayamos definido en nuestra Interfaz.
- Tenemos que implementar TODOS los métodos que haya en la interfaz.
- Será el encargado de comunicarse con la base de datos.
El siguiente paso sería crearnos el Controller.
Tenemos varias formulas para hacerlo.
- Scaffolding
- Nos creará el controller con todos los métodos necesarios indicándole cuando será el Model.
- En blanco
- Nos creará el controller en blanco y tendremos que escribir todo el código que sea necesario en nuestro controller.
Una vez tenemos creado nuestro controller, podemos utilizar varias herramientas para comprobar que todo funciona correctamente:
- Swagger
- Nos los instalará automáticamente al crear nuestro proyecto.
- Tiene una interfaz web muy simple de entender.
- Postman
- Es una aplicación de escritorio
- Podremos crear varios grupos de trabajo en el que cada uno sea una de las APIs que tengamos creadas y queramos probar.
Una cosa a tener en cuenta, es que nuestra API por defecto tendrá la dirección:
https://localhost:44324/api/CONTROLLER
Por eso importante ponerle nombre al controller que haga referencia a los datos con los que vaya a trabajar.
Una vez terminado, ya seremos capaces de utilizar nuestra API en cualquier cliente que vayamos a desarrollar.
Autor/a: Víctor Ramón Pardo
Curso: Desarrollo Web Full Stack, MultiCloud y Multiplataforma
Centro: Tajamar
Año académico: 2021-2022
Código / recursos utilizados / Otros datos de interés: