I have an API which I need to produce documentation for. I've used the following article to setup the documentation on my API and it's working pretty well.
I'm using the: Microsoft.AspNet.WebApi.HelpPage NuGet package to generate documentation for my WebApi and I've been following this tutorial.
http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages
All is working well and I've got some excellent documentation for my Api Endpoints. Sadly the data objects it's returning have no associated documentation and I'm at a bit of a loss as to how to do this. In the past I've used Sandcastle etc and it's combined the documentation files.
So currently as documented I've uncommented the line:
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));
This has allowed documentation for the api assembly to be generated but I can't find a way of referencing additional assemblies.
By I can't find a way of referencing additional assemblies. if you are referring to generating help documentation from models present in other assemblies, then you can take a look at the following response:
How can Xml Documentation for Web Api include documentation from beyond the main project?
Related
I am having a really difficult time navigating the API reference. The old AWS SDK for java used to have all used classes labeled with their proper parameters, errors thrown, and return values. I am not finding this with Amplify.
Currently I am trying to understand the Amplify.storage class for Android. The closest reference I can find for it is here,
https://aws-amplify.github.io/amplify-js/api/classes/storage.html
The problem is that it does not describe the function used by their tutorial, Amplify.Storage.downloadFile()
This all seems to be the javascript implementation of this and not the java based SDK so maybe that is the problem. I've been digging around on google and I can't find anything useful, is there reference material out there that I am just not finding or is this what we have to work with?
As I dig I keep getting linked back to the tutorial which is very frustrating because I want more information than what the tutorial provides.
The Amplify Android project does not currently publish its Javadoc.
I have created an issue for this on the Amplify Android GitHub repo.
For the time-being, your best bet is to read the source code, which does contain JavaDoc. The API for the storage category is here.
It started as simple as that I would like to look up all possible providers. Which ones are allowed?
However, where is the full struct definition?
There isn't a place that I am aware of where the documentation is hosted outside of the GitHub repo here.
I just dig through those and the actual implementation files if needs be to figure out what is available to me if I'm looking for/at new features.
As of WWDC 2019 there is now documentation on Apple's developer website for the package manager. It is here at the time of updating this.
We are using crnk JSON API implementation on the server side (Java). I see the crnk documentation here http://www.crnk.io/documentation/. But, I am not able to find the corresponding Java API Reference documentation. Not sure if there is on available ?
no, so far it is not available. but could be added as PR. release automation is currently in progress and the asciidoc documentation already gets automatically published. Adding JavaDoc next to it would be a minor effort.
In previous versions of ASP.NET, when I created Web Api 2, visual studio automatically wired up automatic generation of documentation for the API.
It's also explained here:
http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages
I'm writing a new project and I've decided to do it with ASP.NET Core, but I don't see anything similar to what existed in the previous versions that generates the documentation from the API (I'm also guessing that's its a bit different since all controllers now inherit from the same Controller class).
But, is there some way to have help files generated for ASP.NET Core APIs?
The functionality you want is at https://github.com/domaindrivendev/Swashbuckle
The following link provides an example of how to configure and use the well-designed utility
https://damienbod.com/2015/12/13/asp-net-5-mvc-6-api-documentation-using-swagger/
John Davidson made a good post showing how to generate Swagger documentation - that is useful and great.
But if you want to stick to ASP.Net MVC 5 - Api Explorer documentation, you should have a look to that excellent blog post :
https://andrewlock.net/introduction-to-the-apiexplorer-in-asp-net-core/
I have some IIS logs with header information I'd like to be parsed by pre-existing frameworks. Can I leverage the part of ASP.NET that uses Browser Definition Files perhaps in tandem with the 51 Degrees mobi tools.
What is the right .NET API (or similar) that I should use to analyze log files?
I'm doing some open source work for 51Degrees at the moment. I wrote an article recently about parsing W3C log files using the C implementation of the API. You can find the article here. Is this the kind of thing you were looking for? Hope this helps.