I am wondering if anyone can point me to which Web-Api Help Generator I should use.
I found this post but it is already a year old and seems to be outdated.
I think ApiExplorer is now Web API Help.
The post also talks about Swagger which from some demos looks a lot nicer and seems like you can do like post requests and such but I am unsure if it still in development as it's been like a year since the last update.
Anyone have any experience with either of them?
The "Web API Help Page" package (Microsoft.AspNet.WebApi.HelpPage) is built on top of ApiExplorer.
Web API Help Page generates documentation pages and adds them to your project.
ApiExplorer gives you a lower-level API that just gives you the API descriptions, which you can use to create documentation.
See: http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages
I haven't used Swagger. From the readme, it's also built on top of ApiExplorer.
Related
Im trying to develop my first Django RESTFul API.
I have implemented some functionality and already got into Routing, Views, Serializers and so on.
Now i would like to setup some Documentation of everything i have currently implemented. So I have set up drf_yasg Swagger Documentation and added routes to the swagger.json and the swagger-ui.
BUT
The most important thing now: I need Api Versioning.
I have implemented two routes (v1 and v2) and the routing is fine.
But the documentation on the swagger site displays BOTH versions. and thats very very ugly. Im now struggeling for hours to find a solution how swagger finds its versions to display on diffrent pages but theres really not documentation about this behavior.
Can anyone help out?
I come from .NET world and there I can implement Swagger with ApiVersioning and Swagger automatically make a dropdown into the ui for me where i can choose, which documentation i w ant to read
Thanks and I hope we can find a solution.
I have a client with a content-heavy site built in CMS Made Simple. The redesign requires a mostly AJAX interface, and I think a frontend framework like Backbone or Angular would be the way to go.
I want to avoid moving off CMS Made Simple, though (client is used to that interface, it will be annoying to migrate all the data).
I think if I could find or create a RESTful api for CMS Made Simple, I'd solve my problem. But after searching around online, I only found CGSocialApp module, which seems to provide a limited API for things like user management. I've also looked into other AJAX solutions for CMS Made Simple, and there don't seem to be good modules for it.
If there is no ready-made solution for me, how complex would building a RESTful API module be? I haven't built a RESTFUL api in a PHP framework before.
Thanks for any guidance!
So, there is no easy answer for this question, as the CMSMS doesn't have a build-in RESTful API.
I would go for one of the two solutions:
1. Output the content as hand made json.
In CMSMS, you really have a lot of control on the templates. You could change the default templates to output json content instead of HTML content. The only issue is that the CMSMS will still send an http content-type header, that you can try to ignore in the JS part.
To access the menu, just remove it from the main template and create an empty page who output the {menu}with a custom template that also build json content.
That's the quick and dirty solution, but it should be very accessible in terms of doing it.
2. Create a dedicated module.
As far as I know, there are no modules that expose the CMSMS in RESTFul format, but a module is really very easy to build. Well, you can try to build it yourself, with the help of the community. It don't really solve the current problem, but it's a hint.
I hope it shed some light on the problem.
How to get started with CodeIgniter and Google Maps API.
I've got a CodeIgniter library specifically for this purpose. You can find more information about it here:
http://biostall.com/codeigniter-google-maps-v3-api-library
A few demos of what can be acheived using the library:
http://biostall.com/demos/google-maps-v3-api-codeigniter-library/
Give me a shout if you have any questions or need any help :)
Enjoy!
CodeIgniter is a backend (server-side) framework. Google Maps API is a frontend (client-side) library. There isn't really any specialized knowledge you need to know about CodeIgniter to get Google Maps working, other than being able to render a view. The question is somewhat flawed in that you assume one depends on the other, when in reality, they are very much decoupled.
The question is similar to how do i get jquery working with codeigniter?...
Reading the CodeIgniter documentation would be a start to understanding how to echo HTML and JavaScript to the browser. The rest is almost entirely client-side JavaScript programming.
I would like to write a web app that uses Dropbox for cloud storage.
If I understand correctly, I should use the Restful API to achieve that.
This documentation exists and is quite good but being a newcomer to Restful API I would love to see and play with a simple example that works with this API.
My questions are:
Am I right to assume that Rest API is the way to go?
Is there a quick and easy example (Maybe a live example) to get me going?
Thanks!
as you tagged your question with "ajax", i presume you want to do this entirely client-side (except for some proxy-code to be able to make requests accross domains)? I haven't tried it out myself, but there's dropbox-js on google code which will at least give you some ideas (and if the Dropbox API didn't change too much since June 2010 it might even work out of the box)?
Update: there's no "download", but you can browse the source code of trunk here.
Here's a lengthy article on the matter
Some love for Javascript Applications with code samples, a demo etc.
i have a web application that uses spring framework
and i want to use ajax in some pages (adding/deleting stuff from page,db without refreshing the whole page)
tutorials and samples are needed for such stuff
The latest version of Spring MVC may be what you are looking for. Here's a good summary of Ajax improvements in the latest version: http://blog.springsource.com/2010/01/25/ajax-simplifications-in-spring-3-0/. This blog links to the sample code used, which you can download and run to see a good working example.
More comprehensive documentation can found here: http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/mvc.html.