JsonApiDotNetCore

Jsonapidotnetcore

Un marco para la construcción de API de REST JSON: API que utilizan .NET Core y Entity Framework Core. Incluye soporte para operaciones atómicas.

El objetivo final de esta biblioteca es eliminar la mayor cantidad de calderas posible ofreciendo características listas para usar, como clasificación, filtrado y paginación. Solo debe concentrarse en definir los recursos e implementar su lógica comercial personalizada. Esta biblioteca ha sido diseñada en torno a la inyección de dependencia, haciendo que la extensibilidad sea increíblemente fácil.

Empezando

Estos son algunos pasos que puede tomar para ayudarlo a comprender qué es este proyecto y cómo puede usarlo:

Acerca de

• ¿Qué es JSON: API y por qué debería usarlo? (Blog, 2017)
• Pragmatic JSON: API Design (Video, 2017)
• JSON: API y JSONAPIDOTNETCORE (VIDEO, 2021)
• JSONAPIDOTNETCORE Release 4.0 (Blog, 2020)
• JSON: API, .NET CORE, Emberjs (Video, 2017)
• Embercasts: Ember Full Stack con ASP.NET Core (curso pagado, 2017)

Documentación oficial

• La especificación JSON: API
• Sitio web de JSONAPIDOTNETCORE
• Hoja de ruta

Proyectos relacionados

• Informes de rendimiento
• JSONAPIDOTNETCORE.MONGODB
• Aplicación de Lista de TODO de Ember.JS

Ejemplos

Consulte el directorio de ejemplos para aplicaciones de muestra actualizadas. También hay una aplicación de Lista de TODO que incluye una API JSONAPIDOTNETCORE y un cliente de Emberjs.

Instalación y uso

Vea nuestra documentación para un uso detallado.

Modelos

#nullable enable

[ Resource ]
public class Article : Identifiable < int >
{
    [ Attr ]
    public string Name { get ; set ; } = null ! ;
}

Middleware

 // Program.cs

builder . Services . AddJsonApi < AppDbContext > ( ) ;

// ...

app . UseRouting ( ) ;
app . UseJsonApi ( ) ;
app . MapControllers ( ) ; 

Compatibilidad

El siguiente cuadro debe ayudarlo a elegir la mejor versión, según su entorno. Ver también nuestra política de versiones.

Jsonapidotnetcore	Estado	.NETO	Núcleo de marco de entidad
3.x	Estable	Core 2.x	2.x
4.x	Estable	Core 3.1	3.1, 5
		5	5
		6	5
5.0.0-5.0.2	Estable	6	6
5.0.3-5.4.0	Estable	6	6, 7
		7	7
5.5+	Estable	6	6, 7
		7	7
		8	8, 9
		9	9
maestro	Avance	8	8, 9
		9	9
Openapi	Experimental	8	8, 9
		9	9

Que contribuye

¿Tiene una pregunta, encontró un error o desea enviar cambios en el código? Vea nuestras pautas contribuyentes.

Probar la última construcción

Después de cada compromiso con la rama maestra, un nuevo paquete NUGET de prelanzamiento se publica automáticamente en los paquetes de GitHub. Para probarlo, siga los pasos a continuación:

1. Cree un token de acceso personal (clásico) con al menos read:packages .

2. Agregue nuestra fuente de paquete a su archivo nuget.config específico del usuario local ejecutando:

   dotnet nuget add source https://nuget.pkg.github.com/json-api-dotnet/index.json --name github-json-api --username YOUR-GITHUB-USERNAME --password YOUR-PAT-CLASSIC

   En el comando anterior:

   • Reemplace su nombre de usuario-GitHub con el nombre de usuario que use para iniciar sesión en su cuenta GitHub.
   • Reemplace su clásico de patato con el token que está creado anteriormente.

   ️ Si el comando anterior no le da acceso en el siguiente paso, elimine la fuente del paquete ejecutando:

   dotnet nuget remove source github-json-api

   y vuelva a intentar el interruptor --store-password-in-clear-text agregado.

3. Reinicie su IDE, abra su proyecto y navegue por la lista de paquetes de la alimentación GitHub-Json-API (asegúrese de que se incluyan paquetes de preliminación previos).

Desarrollo

Para crear el código a partir de este repositorio localmente, ejecute:

dotnet build

Ejecución de pruebas localmente requiere acceso a una base de datos PostgreSQL. Si tiene instalado Docker, esto se puede apoyar a través de:

pwsh run-docker-postgres.ps1

Y luego ejecutar las pruebas:

dotnet test

Alternativamente, para construir, ejecutar todas las pruebas, generar cobertura de código y paquetes Nuget:

pwsh Build.ps1

Patrocinadores