Importing References
To upload a new reference or to override an existing reference, you can do so using our API or by utilizing the editor in the following way:
- Open References
from the sidebar. - Select Import OpenAPI 2/3 Reference
- Choose a valid OpenAPI 2/3 (Swagger) JSON or YAML file.
- Wait until validation and parsing is complete.
Upon the completion of the parsing process, you will receive a notification confirming that the reference has been successfully created. In the event that parsing or validation encounters an issue, an error message will be displayed to inform you of the failure.
If you upload a reference with the same title, then your reference will be overwritten and updated. Your old reference will not be available anymore.
Best Practices for API References
Ensure that every operation is assigned a unique operation ID. Operation IDs play a crucial role in DeveloperHub by facilitating seamless linking to endpoints.
Validation Fail
We will inform you of any detailed validation errors that may exist. To interactively resolve these validation errors, you can utilize our API Editor.
Limitations
The maximum upload size permitted is 8MB.