...
APIs and Proxies appear in this list. You can view details about the API or Proxy by clicking it. You can also set permissions on your API.
Known Issue
Lint issues occur when working with reference accounts, associated JAR files, and error pipelines in older Snaplex versions.
Workaround - Update the Snaplex to the latest version to resolve the lint issue.
Create the API using Design First
...
Any structural or syntax issues in the API, API Version, or Proxy specification file will give results in an error in the SnapLogic UI. You can change the specifications according to the error message in the Swagger editor or any other editor tool.
Entity | Error Messages for |
---|
Incorrect JSON or YAML (OAS2.0 or OAS3.0) Specifications | Description and Resolution | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
API and Proxy |
|
|
|
|
Example Workflow
Create an API in the API Manager using with the upload option. Upload the OAS 2.0 or 3.0 YAML or JSON API Specification file:
If the file contains an incorrect data or has a broken broke code structure then it gives , an error occurs:
You can edit the specification file in the Swagger editor:
After fixing all the errors in the Swagger editor are fixed, the API is successfully created with the edited API specification file.
...
In the API Manager page, under the APIs & Proxies tab, click the add icon ( ) and choose New API.
In Create New API, choose Create from Existing Project and select the Project.
Click Continue.
In Create New API - Select Assets, select the types of assets you want to import to the new API. An Asset selected at the root level also imports the leaf-level Assets.
Click Import and Continue.
In Create New API - Details, fill in the details for the new API.
General Info
Name (Title). The name of the new API.
The name must meet the following requirements:
Must be unique.
Must begin with alphanumeric characters A-Z, a-z, or 0-9.
Cannot contain the reserved keyword shared.
Cannot contain |, <, >, [, ], {, }, #, ?, /, and \.
Must be no more than 256 characters. If the name includes double-byte characters, the maximum length is shorter.
Description. A description of the new API.
Version. The version number for the first version of the API.
Default: 1.0.
Learn more: Managing Versions of Your APIsTags. Enter any tags associated with your API. You can create the tags as required.
Endpoint Configuration » Path to Endpoint. (Read-only) The base path for the endpoint.
Server Configuration » Snaplex. The Snaplex to associate with the new API.
Click Create.
Info |
---|
|
Create the API from a Git repository
...