API Designer

API Designer Concept

API Designer supports the API development process with a spec first approach. In this approach, the OpenAPI/Swagger specification is created first, then the API Proxy is created from this specification.

Spec First Approach

OpenAPI/Swagger specification is created first

API design starts with specification.

Specification Editing

Editing OpenAPI/Swagger specification

Creating and editing specifications in YAML/JSON format.

Automatic Documentation

Automatic documentation generation from specification

Documentation is generated from OpenAPI spec.

API Proxy Creation

Creating API Proxy from specification

Creating API Proxy from OpenAPI spec.

API Designer Features

OpenAPI/Swagger Specification

Creating and editing OpenAPI/Swagger specifications in spec first approach:

OpenAPI Editor

• OpenAPI/Swagger editor
• YAML/JSON editing
• Validation
• Syntax checking

Schema Design

• JSON Schema design
• XML Schema design
• Data model design
• Request/Response schemas

Endpoint Design

• Endpoint definition
• HTTP method determination
• Path parameters
• Query parameters

Documentation Generation

Automatic documentation generation from OpenAPI/Swagger specification:

Automatic Documentation

Automatic documentation generation from OpenAPI spec

• Documentation generation from specification
• Markdown support
• Adding custom documentation

Documentation Preview

Generated documentation can be previewed

• Real-time preview
• Portal view simulation
• Documentation quality check

Documentation Export

Documentation can be exported in different formats

• PDF export
• HTML export
• Markdown export

API Designer Usage Scenarios

API development scenarios with spec first approach:

Spec First API Development

1. Creating OpenAPI/Swagger specification
2. Defining endpoints and schemas
3. Validating specification
4. Creating API Proxy from specification
5. Generating automatic documentation
6. Publishing in API Portal

Existing API Documentation

1. Creating OpenAPI spec from existing API
2. Editing and updating specification
3. Improving documentation
4. Adding examples and descriptions
5. Publishing in Portal

API Designer and API Manager Relationship

API Designer works integrated with API Manager with spec first approach. Workflow:

API Designer
   │
   │ OpenAPI/Swagger Spec
   │ (Spec First)
   │
   ▼
API Manager
   │
   │ Creating API Proxy from Spec
   │ Configuration
   │
   ▼
API Gateway

1. Spec Creation

OpenAPI/Swagger specification is created in API Designer

API design starts with specification in spec first approach.

2. Spec Validation

Specification is validated and checked

Compliance check with OpenAPI standards is performed.

3. API Proxy Creation

API Proxy is created from specification in API Manager

API Proxy is automatically created from OpenAPI spec.

4. Documentation and Deployment

Documentation is generated and API is deployed

Automatic documentation is produced and API is deployed to API Gateway.

bilgi

This integration between API Designer and API Manager provides a seamless process from API design to deployment with spec first approach. Specification is created first, then API Proxy and documentation are automatically generated from this specification.

API Designer Advantages

Advantages provided by spec first approach:

Spec First Approach

• API design starts with specification
• Standard OpenAPI/Swagger format
• API design without writing code

Automatic Generation

• Creating API Proxy from specification
• Automatic documentation generation
• Consistent API structure

Standard Compliance

• Compliance with OpenAPI/Swagger standards
• Interoperability
• Tool support

Up-to-Date Documentation

• Automatic documentation from specification
• Documentation-specification synchronization
• Portal integration

Next Steps

API Creator

Learn about API Creator component

API Portal

Learn about API Portal component

API Design

API design guide

OpenAPI

OpenAPI usage