Adding Applications & Services
Once you have a project, populate it with applications and services that define your API surface.
Adding an Application
- Select the project node in the tree (or click it).
- Click Add Application in the toolbar, or right-click the project node and choose Add Application.
- The application is added as Application #N.
An application is a container for related services. Edit its Name and Description in the Application Panel (shown when the application node is selected). Most extensions have one application, but you can add several if your extension covers multiple API products.
Adding a Service
- Select an application node in the tree.
- Click Add Service in the toolbar, or right-click the application node and choose Add Service.
- A blank service named Service #N is created and the Service Panel opens.
To import a service from a specification, configure the new service in the Service Panel rather than picking a format from a menu:
- Set the Service Type (see table below).
- Enter the Definition URI — a file path or URL to the spec. Use Browse to pick a local file, or Test Connection to verify a network URI.
- If the spec requires authentication, fill in Username and Password.
- Click Analyze (or Re-analyze) to fetch the spec, generate types, and populate the service's operations.
API Designer Services
Right-click an application node and choose Design Service to create a Designer (API Designer) service. Operations and schemas are defined in-place with the built-in designer and stored inside the project file; an OpenAPI YAML spec is generated on demand.
Manual Services
Leave the Definition URI empty and define operations yourself (or use the API Designer). Manual services are useful when no formal spec exists, or you need a custom subset of operations.
Service Types
| Service Type (exact label) | Imported from |
|---|---|
| OpenAPI | OpenAPI / Swagger document |
| WSDL | WSDL (SOAP) document |
| CSDL | OData CSDL / EDMX metadata |
| Kafka Schema Registry | Confluent-compatible Schema Registry |
| GraphQL | GraphQL SDL or introspection endpoint |
| gRPC (Protobuf) | .proto file |
| WebSocket (AsyncAPI) | AsyncAPI 3.0 document |
| Designer (API Designer) | Defined in-place (see above) |
The Service Panel also shows the service Status tag (Not Analyzed / Analyzed), a Service Description tab listing discovered description files, and a Logs tab with analysis output.
Service Settings
| Setting | Description |
|---|---|
| Name | Display name in the service tree |
| Service Type | Import format (OpenAPI, WSDL, CSDL, Kafka Schema Registry, GraphQL, gRPC, WebSocket, Designer) |
| Definition URI | File path or URL to the spec (empty for manual/designer services) |
| Username / Password | Credentials for authenticated specs |
| Description | Markdown documentation for the service |
Re-analyzing
After modifying a service definition, click Re-analyze to regenerate types and refresh operation metadata. This is faster than a full rebuild and useful for iterative development. Analyze and Re-analyze are also available from the right-click menu on any node.
The analysis progress is shown by an indeterminate progress bar and, for multiple services, a "completed / total" tag in the toolbar.
Deleting Items
- Right-click an application and choose Delete Application, or right-click a service and choose Delete Service. You are asked to confirm.
- Deleting an application removes all its services and operations.
- Deletion is immediate within the project — Save the project to persist.