swagger-api-swagger-editor
- Description:
Next generation Swagger Editor is here! Edit OpenAPI definitions in JSON or YAML format in your browser and preview documentation in real time. Generate valid OpenAPI definitions for full Swagger tooling support. Upgrade to SwaggerEditor@5 for OpenAPI 3.1.0 support and enjoy a brand-new version built from the ground up. Get your Swagger Editor now!
- Copyright:
- 2025 Eyevinn Technology AB
Methods
(async, static) createSwaggerApiSwaggerEditorInstance(context, body) → {SwaggerApiSwaggerEditor}
- Description:
Create a new Swagger Editor instance
Example
import { Context } from '@osaas/client-core';
import { createSwaggerApiSwaggerEditorInstance } from '@osaas/client-services';
const ctx = new Context();
const body: SwaggerApiSwaggerEditorConfig = { name: 'myinstance', ... };
const instance = await createSwaggerApiSwaggerEditorInstance(ctx, body);
console.log(instance.url);Parameters:
| Name | Type | Description |
|---|---|---|
context |
Context | Open Source Cloud configuration context |
body |
SwaggerApiSwaggerEditorConfig | Service instance configuration |
Returns:
- Service instance
(async, static) getSwaggerApiSwaggerEditorInstance(context, name) → {SwaggerApiSwaggerEditor}
- Description:
Get a Swagger Editor instance
Example
import { Context } from '@osaas/client-core';
import { getSwaggerApiSwaggerEditorInstance } from '@osaas/client-services';
const ctx = new Context();
const instance = await getSwaggerApiSwaggerEditorInstance(ctx, 'myinstance');
console.log(instance.url);Parameters:
| Name | Type | Description |
|---|---|---|
context |
Context | Open Source Cloud configuration context |
name |
string | Name of the editor to be retrieved |
Returns:
- Service instance
(async, static) removeSwaggerApiSwaggerEditorInstance(context, name)
- Description:
Remove a Swagger Editor instance
Parameters:
| Name | Type | Description |
|---|---|---|
context |
Context | Open Source Cloud configuration context |
name |
string | Name of the editor to be removed |