Scrape/upload API
About APIs in Vaktum
Vaktum is using the interface specification of a software platform to test and generate artifacts such as SDKs and data models.
As such the first step in Vaktum is to provide an API specification. There are 2 key ways of doing so:
- Privide an OpenAPI specification:
- Scrape a public API Documentation
Upload OpenAPI specification
If available, uploading an OpenAPI specification is the best and most accurate option. Vaktum supports OpenAPI 2 (swagger) and OpenAPI 3 specifications. Filetypes can be json, yaml, or yml.
Once the file has been located, it can be used directly in the Vaktum CLI application or uploaded through Vaktum.com or the Vaktum API
Scrape API Documentatin
In case no OpenAPI specification file is available, Vaktum can read and ingest an API Documentation accessible online.
To start scraping a public API documentation provide the URL of the API Documentation through Vaktum.com or make a requet to the Vaktum API.