Custom made web api module for OrchardCore.Cms gnerally used as synchronization entry point. E.g. you have main back-end service and CMS (in this case OrchardCore CMS) used by your content managers, and let's say you need to retrieve content from CMS to show it to users or cache in youe main database, this is where OrchardCoreModule.WebApi can help you.
At the moment, this project only tested manually by the team of two QA's and cutting edge bugs not found, but automated tests are on their way.
There are 5 major steps to add this module to your OrchardCore CMS instance:
- Create an empty ASP.NET Core project
- Configure it to use OrchardCore.Cms
- Add OrchardCoreModule.WebApi as a reference to this project
- Apply procedures scripts from Database folder
- Enable WebApi module in OrchardCore CMS settings
For more information on each of the steps visit projects wiki
OrchardCoreModule.WebApi currently supports only following DB providers:
- PostgreSQL (9.5+)
- Microsoft SQL Server (2017+)
List of implemented API methods can be found on this wiki page.