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.
Related
I am trying to configure event arc using node.js code. any idea on how Event-Arc configuration can be done with node.js.
Because there is a lot of lacking information in your question I will have to do some assumptions.
If you want to set up Eventarc, there is a client library for NodeJS available here.
Depending on your use case you either want to read about
Triggers that are listening for Google source (docs)
Third party integrations (docs)
Custom events integration via Firebase (docs)
I am aware that you can create and delete incoming webhooks using the ReadTheDocs UI (for GitHub, GitLab, etc. integration), but I need to be able to do this without accessing the UI to automate the process. Is this possible? Or will webhook management be added to the API soon?
The API v3 documentation does not list an endpoint to add an integration. Therefore, at the moment this is not possible.
For feature requests, it's better to open an issue upstream.
I need to start an Activity workflow from an external HTML form (outside activiti). I do not want to use the form that Activiti provides.
I am using Alfresco Activiti BPM Suite v1.4.0. Any pointers ?
If you are running activiti in Alfresco, you can implement a webscript that will receive the post of your form and will start the task.
If you are running a standalone Activiti, you can use the activiti REST api.
I do not have code to share but the documentation should be enough to get started.
You can find a good example at: Rest API
This makes use of Spring Boot. In practice, you can develop your REST API that starts the process and then you can call the service directly from the browser using Ajax, or post to your application and execute the REST call from there.
To be honest, I have never done it, but it seems a possible solution.
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!
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.