OpenAPI Import
Import existing OpenAPI specifications to create REST API documentation with endpoints, schemas, and security definitions.
NeoArc Studio can import OpenAPI 3.0 specifications to create REST API documentation. This allows you to work with existing API definitions and enhance them with NeoArc's documentation features.
What Gets Imported
| Element | Details |
|---|---|
| API information | Title, description, version, contact |
| Servers | Base URLs and server definitions |
| Endpoints | All paths with HTTP methods |
| Parameters | Path, query, header, and cookie parameters |
| Request bodies | Request schemas and content types |
| Responses | Response schemas for all status codes |
| Security schemes | Authentication definitions |
| Schemas | Component schemas become NeoArc schemas |
Import Process
Supported Formats
| Format | Notes |
|---|---|
| OpenAPI 3.0.x | JSON or YAML format supported |
| Swagger 2.0 | Converted during import |
After Import
Once imported, you can:
Schema Handling
OpenAPI component schemas are converted to NeoArc schema definitions: