This talk was presented at API The Docs Virtual 2020 event series on 10 June. We are glad to present the video recording, slide deck and talk summary below. Enjoy!
Visit our talk recaps ToC page for an overview of all presentations!
An API “Playground” Enables you to try out a company’s API from the browser without writing any software or script. API Explorers are tools for making live calls to the API endpoints.
Some devportal refer to their API Reference documentation website as an API Explorer. So, “API Explorer” is also used for static API documentation.
Primary benefits of API Explorers:
Text areas for creating API request:
An API Explorer that supports:
Additional features in the tool:
To have an API Explorer that supports click configuration and deeply nested API elements:
Use the open source Google Blockly library that enables an easy update of the library
Use the builder pattern to add data to the request object - the user does not have to worry about erase, child or grandchild objects
As result: the blocks are easy to edit and form the most complicated API requests
An additional layer of software takes the fluent input and produces the JSON output
(e.g. from Node.js to JSON)
Automated array creation: the Builder tool uses the Swagger file definitions to automatically create arrays as needed
Automatic object creation:
Auto-programming the API’s SDK: CodeGen software generates SDKs from the OAS and the Builder tool uses recursion to auto-program the SDK
The tool is built from the API’s Swagger file (OAS): as a separate batch process, a configuration app parses the Swagger file and creates the block definitions.
No significant server component. The tool makes direct calls to DocuSign via CORS.
Single page React application with the Docusign inhouse-style library
See the Builder Tool demo in the presentation to find out how DocuSign could meet the goals.
“In essence, creating an accessible developer portal ensures that you provide a better user experience to the wides… https://t.co/27qHNJQiSC