I have built some REST API in Laravel micro framework and it's working fine. Now I want to automatically generate the documentation in Laravel through request and response into it so the API will be well documented on future use. Has anyone done this?
Related
has anyone done an enterprise integration of their public API with Postman? Checking Postman pages it seems like everything is straightforward, however, I have some concerns:
I don't see the way to automatically install pre-request scripts. Pre-request scripts allow an easy and straightforward way to call the endpoints without going through authentication step manually.
If you use sync with Github you'll need to give Postman full access. Not sure how people work around that.
You need to convert swagger to postman definition. Default Postman has limited nested levels of API schema, which means your API documentation will need additional processing step
So I don't know if it's worth integrating API release to the Postman with the internal API management system, or rather have a simple script on a virtual machine.
I need to make some Jira REST calls in my web API application. But I have encountered difficulties around creating authentication using Oauth 2.0 according to documentation below:
https://developer.atlassian.com/cloud/jira/service-desk/oauth-2-authorization-code-grants-3lo-for-apps/
I need help on how I can call the step 1 of the above documentation in postman and subsequently, in my code to obtain the authorization code without going through a browser to paste this link below, as I am working with a backend web API application.
https://auth.atlassian.com/authorize? audience=api.atlassian.com& client_id=YOUR_CLIENT_ID& scope=REQUESTED_SCOPE_ONE%20REQUESTED_SCOPE_TWO& redirect_uri=https://YOUR_APP_CALLBACK_URL& state=YOUR_USER_BOUND_VALUE& response_type=code& prompt=consent
I hope to get suggestions as this has been a blocker for me for days. Thanks.
Is there any solution to automatically generate a web UI from a REST API?
I found Swagger codegen but it generates a client for the API, not a UI.
I need a basic UI, allowing directly from the browser to use the different endpoints and display the response prettily. Something like a basic Postman that would be directly integrated into my website.
I don't have constraint about how the generation is done. Can be done once at build time, or at runtime on server side or on client side.
I've heard good things about retool.com, it seems to do what you need.
I am trying to implement Docusign in my application for digital signature. I am using .net core 2.0 for development purpose. I found that the Docusign SDK(https://www.nuget.org/packages/DocuSign.eSign.dll/) is not compatible with .net core so I tried with the other one (https://www.nuget.org/packages/DocuSign.Core). The general signature request is working fine but when it comes to Embedded Signing, there is no method available in the SDK(but is available in the original SDK). I am using REST API to complete Embedded signing process and is working fine for now.
Now I want to keep track the status of the document(like when it is delivered, when it is signed by signers and so on). I am configuring webhook to accomplish this task but not getting the webhook object in the webhook endpoint. I referred few documents ("https://github.com/docusign/recipe-010-webhook-csharp/blob/master/Webhook/Controllers/WebhookController.cs", "https://developers.docusign.com/esign-rest-api/code-examples/webhook-status",
"https://www.docusign.com/blog/dsdev-msbuild2018-session-thr2605/") to see how a webhook works but looks like none of them is working. In the examples, everyone is getting the webhook object inside request content(request.Content.ReadAsStreamAsync()) but I am getting null at Content.
Can someone help me out to resolve this issue. A sample code or helpful documents(apart from the one I am referring) would be great.
Thank you.
Re: .Net Core SDK support -- we hear you and we're working on it.
Re: webhook setup --
How are you creating the webhook subscription? Via the Administration tool or via the eventNotification object in the Envelopes::create call?
To get going, I'd suggest using the Administration tool. Use the Connect screen to add a webhook notification subscription to your server (your "listener"). Then you'll receive notifications for the events you've indicated an interest in.
Your server must support https and be available on the public internet so DocuSign can send POST requests to it.
I'd like to create a website with authentication using REST framework. Well I'd not like to use it because I didn't understand everything about it, but I have to.
Can I use the REST API and yet have custom templates for administration and simple browsing ?
What I mean is that when I did the REST tutorial (on their website), I didn't see at all where I could put my templates instead of the ones generated by REST. How can I for example use the authentication of REST with my interface, my web template ?
Cannot figure out what do you mean by custom templates ?
Incase you want to begin with REST then you may start with jersey framework. For Security you may use OPenID or the latest OAuth2.0 specs
Here is my tutorial for REST + OAuth2.0
http://restful-fundamentals.blogspot.in/2013/02/rest-and-http.html
http://restful-fundamentals.blogspot.in/2013/04/oauth-20-introducation.html
Google code repo: http://restful-fundamentals.blogspot.in/2013/04/svn-repository-oauth20-spectifications.html