Skip to content

Latest commit

 

History

History
36 lines (21 loc) · 1.3 KB

README.md

File metadata and controls

36 lines (21 loc) · 1.3 KB
Raw

NexusatAspNetCore REST API µ-Framework

Build status codecov

WORK IN PROGRESS…

Todo…

Documentation

You can find the documentation here.

Response Model

Basically when you implement a RESTful API you can choose among three kind of response:

Respone Model

  • StatusBase: basic response
  • IApiObjectResponse<TData>: for API that returns a simple object conforming to TData
  • IApiEnumResponse<TData>: for API that returns a paginated list of objects conforming to TData

Dotnet CLI Integration

Use the solution Nexusat.AspNetCode.Code.sln to build and test via dotnet CLI interface.

Contribution

The documentation is produced using DocFX. The project docfx_project is the source root. In order to build the artificats is required docfx installed on your building environment.

Mac Setup

Just run brew install docfx to setup your machine.