Orchard Core OpenAPI Code Generation Tools based on NSwag

Provides a dynamic OpenAPI definition for Orchard Core Content Types and REST API Controllers.

This project is heavily based on NSwag and provides a wrapper and dynamic Content Type functionality for Orchard Core.

• Dynamic Content Type JSON Schema generation.
• Client tool generation for Content Type Dto models.
• Client tool generation for Orchard Core REST API Controllers.
• Swagger UI for Orchard Core.

Install the ThisNetWorks.OrchardCore.OpenApi module to your Orchard Core Host project.

Enable the Orchard Core OpenAPI feature.

Refer the sample projects for example NSwag client.nswag and models.nswag configurations.

Install NSwag Studio.

Generate your API Client.

Install the ThisNetWorks.OrchardCore.OpenApi.Abstractions package for access to base classes and extension methods, such as

• contentItem.ToDto<BlogPostItemDto>()
• contentItem.FromDto(dto)

to convert back and forth between dto classes and content items.

This is useful if you are using these generated models within the context of an Orchard Core project to create your own REST API Controllers.

There are two sample projects included

• Orchard Core Sample
  • Install using the Open Api recipe.
  • Includes example REST API Controller (/foo).
• Console Client Sample
  • Console Client which connects to the Orchard Core Sample and mutates content items with the Content API Controller

Currently build against

• Orchard Core Version 1.0.0-rc2-13450
• NSwag Version 13.6.1
• NJsonSchema Version 10.1.21