We set up a web API for project internal usage.
I'm looking for a nice way to document our API. I've searched the web and found
IO Docs
Swagger
These tools read in JSON files that can be created automatically, e.g. for Java. Our API has grown and I like to create the JSON manually, but not by hand in a text editor. Is there a tool or frontend that eases the burden of creating the descriptive JSON manually?
On the other hand, what are recommendable tools for the documentation of a web API?
I work in a .NET (C#) shop and we use swagger to document our apis. We couldn't find any tools to do what your asking...so we just created our own. I don't think swagger is mature enough to spawn utility projects like that...yet.
It was not to difficult to create classes to represent the json objects described by the swagger documentation. We just take these instantiated classes and run them through a JSON serializer to get our individual json files describing our endpoints.
Best of luck!
Related
want to make it easy for my make an automatic conversion (using a CLI or API) of 3D models (DWG/DXF) into STEP files.
I have tried to read the documentation for Autodesk Forge to see if that could help me, but have a hard time to understand if it can.
Can I do this with Autodesk Forge?
Is there some other way to do it?
Is there a better way to do it?
How about to start with a working sample? Below is a few good starting points for your requirements:
https://github.com/Autodesk-Forge/bucket.manager-csharp-sample.tool
https://github.com/Autodesk-Forge/forge.commandline-curl
https://github.com/Autodesk-Forge/forge.commandline-nodejs
And feel free to find more samples here:
https://github.com/Autodesk-Forge
https://forge-rcdb.autodesk.io
https://forge.autodesk.com/blog
https://autodesk-forge-showroom.herokuapp.com
Basically to either build scripts or app in any language of your choice (the beauty of RESTful API being language neutral) to automate the workflow for you requirements can be broken down to:
Persist model files to/Read from your persistence (entirely your domain) -> Persist the model to Forge OSS (doc here] > Call the conversion job(doc here and supported formats -> Poll for job status and retrieve a manifest for download (here)-> Dowbload and persist the output (derivatives) (here)
Edit:
To convert DWG to STP (which is not yet supported by the Translation Service), use the Design Automaion for AutoCAD service to automate the process. Basically you will need to create a .NET plug-in to export DWG to STP, submit the module as an AppPackage and invoke the automation activity via the service endpoints. See here for details.
I am currently looking at the article Solidworks Configuration Properties.
Once a part is uploaded we use the modelderivative API to extract the part information, this additional config data does not seem to be accessible anywhere through these APIs.
Is there another endpoint to call to be able to extract this data or is the only implementation currently handled through the viewer as demoed in the article?
Cheers
I understand that creation of Rest api documentation using swagger Ui generates a few jsons
Do other developers need to use swagger UI installation on their laptop to view these ?
What is the best way to view such a documentation
The general way is to host your own swagger ui instance on your servers, exposing the REST documentation. When all fails, and assuming you've enabled CORS, you can use the online petstore and paste the URL to you Swagger there.
I'm converting my Play 2 application to a SPA and I'm trying to figure out how to still use SecureSocial for authentication.
I'm removing all the HTML templates (except the ones used by SecureSocial to send emails) and modifying my controllers to only provide JSON responses.
Is it possible to prevent SecureSocial from rendering HTML and let my application exchange authentication data in JSON format? Is there any example or tutorial that explains this topic? I've been googling for a few days now and unable to find any useful or at least understandable information for a newbie like me.
Latest changes in master made SecureSocial more friendly with mobile and SPA apps. You can now use the LoginApi controller to authenticate a user using the UsernamePasswordProvider or any of the OAuth2 based providers.
So, Google Places API allows me to receive JSON data through a Google Places API search using a simple:
"https://maps.googleapis.com/maps/api/place/search/json?location=-33.8670522,151.1957362&radius=50&client=clientId&sensor=true_or_false&signature=SIGNATURE"
(note, includes signature/key).
Why does SimpleGeo not allow this same feature? Is it possible? What is the purpose of all of this server side code that SimpleGeo uses?
Regards,
Ryan
SimpleGeo has recently announced a JavaScript SDK, which includes a JSONP API. This should allow you to do exactly what you're asking -- requesting read-only information from their Context and Places APIs purely from the client side with a simple key to authenticate the request.
I think there are still plenty of purposes for accessing SimpleGeo's data from a server-side application -- not all developers are writing purely JavaScript client-side applications -- but I agree that this new SDK will help a lot of developers.
Also, if you're looking for straightforward REST access to JSON resources without any client libraries, that's also present. See SimpleGeo's documentation on API endpoints.