JsonApiDotNetCore

(โ˜… 715)

A framework for building JSON:API compliant REST APIs using ASP.NET and Entity Framework Core.

Showing a partial file list โ€” download the zip above to see everything.

  • .editorconfig
  • .gitattributes
  • .gitignore
  • Build.ps1
  • cleanupcode.ps1
  • CODE_OF_CONDUCT.md
  • codecov.yml
  • CodingGuidelines.ruleset
  • Directory.Build.props
  • Directory.Build.targets
  • inspectcode.ps1
  • JetBrainsInspectCodeTransform.xslt
  • JsonApiDotNetCore.slnx
  • JsonApiDotNetCore.slnx.DotSettings
  • LICENSE
  • nuget.config
  • package-icon.png
  • package-versions.props
  • PackageReadme.md
  • README.md
  • ROADMAP.md
  • run-docker-postgres.ps1
  • VERSIONING_POLICY.md
  • WarningSeverities.DotSettings

# Installation Guide

1. Get the code
git clone https://github.com/json-api-dotnet/JsonApiDotNetCore

Downloads the entire project code from GitHub to your computer.

cd JsonApiDotNetCore

Moves into the project folder you just downloaded.

2. .NET

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • .NET SDK The SDK required for the dotnet command.
dotnet new webapi --no-openapi --use-controllers --name ExampleJsonApi

Type this command into your terminal and run it.

dotnet add package JsonApiDotNetCore

Type this command into your terminal and run it.

dotnet add package Microsoft.EntityFrameworkCore.Sqlite

Type this command into your terminal and run it.

- The [examples](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/src/Examples) directory provides

Type this command into your terminal and run it.

- The [integration tests](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/test/JsonApiDotNetCoreTests/IntegrationTests)

Type this command into your terminal and run it.

โœ… After dotnet run, check the message or address shown in the terminal.

Pulled directly from this repo's README.

// repository documentation