JsonApiDotNetCore

Jsonapidotnetcore

Un framework pour la construction d'API REST JSON: API à l'aide de .NET Core et Entity Framework Core. Comprend le soutien aux opérations atomiques.

L'objectif ultime de cette bibliothèque est d'éliminer autant de passe-partout que possible en offrant des fonctionnalités prêtes à l'emploi telles que le tri, le filtrage et la pagination. Il vous suffit de vous concentrer sur la définition des ressources et la mise en œuvre de votre logique commerciale personnalisée. Cette bibliothèque a été conçue autour de l'injection de dépendance, ce qui rend l'extensibilité incroyablement facile.

Commencer

Ce sont quelques étapes que vous pouvez prendre pour vous aider à comprendre ce qu'est ce projet et comment vous pouvez l'utiliser:

À propos

• Qu'est-ce que JSON: API et pourquoi devrais-je l'utiliser? (Blog, 2017)
• Pragmatic JSON: API Design (Video, 2017)
• JSON: API et JSONAPIDOTNETCORE (VIDEO, 2021)
• JSONAPIDOTNETCORE REMARDE 4.0 (Blog, 2020)
• JSON: API, .NET CORE, EMBERJS (VIDEO, 2017)
• Embercasts: Ember Ember avec ASP.Net Core (Course Paye, 2017)

Documentation officielle

• La spécification JSON: API
• Site Web JSONAPIDOTNETCORE
• Feuille de route

Projets connexes

• Rapports de performance
• Jsonapidotnetcore.mongodb
• Application de liste de tâches Ember.js

Exemples

Voir le répertoire des exemples pour les applications d'échantillons à jour. Il existe également une application ToDo List qui comprend une API JSONAPIDOTNETCORE et un client Emberjs.

Installation et utilisation

Voir notre documentation pour une utilisation détaillée.

Modèles

#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 ( ) ; 

Compatibilité

Le tableau suivant devrait vous aider à choisir la meilleure version, en fonction de votre environnement. Voir aussi notre politique de versioning.

Jsonapidotnetcore	Statut	.FILET	Noyau de cadre d'entité
3.x	Écurie	Noyau 2.x	2.x
4.x	Écurie	Core 3.1	3.1, 5
		5	5
		6	5
5.0.0-5.0.2	Écurie	6	6
5.0.3-5.4.0	Écurie	6	6, 7
		7	7
5.5+	Écurie	6	6, 7
		7	7
		8	8, 9
		9	9
maître	Prévisualisation	8	8, 9
		9	9
openapi	Expérimental	8	8, 9
		9	9

Contributif

Vous avez une question, vous avez trouvé un bogue ou vous souhaitez soumettre des modifications de code? Voir nos directives contributives.

Essayer la dernière construction

Après chaque engagement dans la succursale Master, un nouveau package NuGet pré-libéré est automatiquement publié sur les packages GitHub. Pour l'essayer, suivez les étapes ci-dessous:

1. Créez un jeton d'accès personnel (classique) avec au moins read:packages Scope.

2. Ajoutez notre source de package à votre fichier local nuget.config spécifique à l'utilisateur en exécutant:

   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

   Dans la commande ci-dessus:

   • Remplacez votre nom d'utilisateur-github par le nom d'utilisateur que vous utilisez pour connecter votre compte GitHub.
   • Remplacez votre classe-classique par le jeton que vous avez créé ci-dessus.

   ️ Si la commande ci-dessus ne vous donne pas accès à l'étape suivante, supprimez la source du package en exécutant:

   dotnet nuget remove source github-json-api

   et réessayer avec le commutateur --store-password-in-clear-text ajouté.

3. Redémarrez votre IDE, ouvrez votre projet et parcourez la liste des packages à partir du flux GitHub-Json-API (assurez-vous que les packages de pré-libération sont inclus).

Développement

Pour créer le code à partir de ce référentiel localement, exécutez:

dotnet build

L'exécution de tests localement nécessite l'accès à une base de données PostgreSQL. Si Docker a installé, cela peut être soutenu via:

pwsh run-docker-postgres.ps1

Puis pour exécuter les tests:

dotnet test

Alternativement, pour construire, exécuter tous les tests, générer une couverture de code et des packages NuGet:

pwsh Build.ps1

Sponsors