Frequently Asked Questions - FAQs
Where do I find the Neuron API UI URL?¶
If the Neuron allows it, the API URL can be found by navigating through the Neurons tab, selecting the specific Neuron, clicking the API tab, and then clicking the API Swagger button.
What is Swagger?¶
Swagger is an Open Source set of rules, specifications and tools for developing and describing RESTful APIs. The Swagger framework allows developers to create interactive, machine and human-readable API documentation.
API specifications typically include information such as supported operations, parameters and outputs, authorization requirements, available endpoints and licenses needed. Swagger can generate this information automatically from the source code by asking the API to return a documentation file from its annotations.
Swagger helps users build, document, test and consume RESTful web services. It can be used with both a top-down and bottom-up API development approach. In the top-down, or design-first, method, Swagger can be used to design an API before any code is written. In the bottom-up, or code-first method, Swagger takes the code written for an API and generates the documentation.