OpenAPI / REST

Loading an OpenAPI Specification

Vaktum supports loading your API definition through OpenAPI specifications. This is the most common way to define your API for testing and validation.

Upload via Vaktum.com

1. Navigate to the APIs section of Vaktum.com
2. Click "Upload API"
3. Choose the OpenAPI specification file from your computer
4. Your API will be processed and available for validation and testing

Upload via Vaktum CLI

You can also load OpenAPI specifications directly using the Vaktum CLI:

vaktum validate --api <Path to your OpenAPI file>

Upload via Vaktum API

Using the Vaktum API, you can programmatically upload your OpenAPI specification:

curl -X POST "https://api.vaktum.com/v1/apis" \
  -H "X-API-KEY: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"name": "My API", "description": "API description", "file": "base64-encoded-openapi-file"}'

Supported Formats

Vaktum supports the following OpenAPI formats:

• OpenAPI 3.0.x (JSON and YAML)
• OpenAPI 3.1.x (JSON and YAML)
• Swagger 2.0 (JSON and YAML)

Scraping API Docs

If you don't have an OpenAPI specification file, Vaktum can scrape your API documentation to generate one:

1. Go to the APIs section of Vaktum.com
2. Click "Scrape API"
3. Enter the URL of your API documentation
4. Vaktum will extract the API definition and convert it into an OpenAPI specification