Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding documentation for Web Api in Orchard #205

Merged
merged 3 commits into from Sep 18, 2015

Conversation

wharri220
Copy link
Contributor

Done on behalf of Radio Systems Corporation

@wharri220
Copy link
Contributor Author

Indeed a typo, fixed that. Thanks!

abhishekluv added a commit that referenced this pull request Sep 18, 2015
Adding documentation for Web Api in Orchard
@abhishekluv abhishekluv merged commit 1b1d37a into OrchardCMS:master Sep 18, 2015

Since Orchard doesn't have the concept of an AppStart file, in order to add custom configuration to Web Api in Orchard, you must do so in an Autofac module. For example, the following will set the default Web Api return type to Json, and will ensure that Json objects/properties returned by the Api follow the camelCased naming convention.

namespace Blue.Core {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should have kept the same namespace than your example : MyCustomModule

@agriffard
Copy link
Member

It reminds me this article : http://sebastienros.com/web-api-makes-it-in-orchard

@wharri220
Copy link
Contributor Author

That is a good article about Web API in Orchard from one of the Orchard project's core developers. Very useful information. I've seen very similar information on several blog posts and articles, and as a developer actively working on Orchard projects, I've gained much knowledge of using Web Api within Orchard for myself. I felt the information needed to be included in the documentation for the Orchard project. It will be more useful to new Orchard developers who aren't as knowledgeable of the community. And it's often been stated in the Orchard community that any additions to the documentation is greatly needed and appreciated, as it's somewhat lacking.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants