Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIGen Tests API

Create and run automated API tests.

APIGen Tests API is one of 8 APIs that APIGen publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Tests. The published artifact set on APIs.io includes an OpenAPI specification, a GitHub repository, a JSON-LD context, and 4 JSON Schemas.

This API exposes 5 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.apigen.com/v1.

5 operations 3 paths 5 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.apigen.com/v1
Authentication
HTTP Bearer, API Key
License
Resource Areas
1

Authentication & Security 2

APIGen Tests API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as X-API-Key (apiKey). By default, every request must be authenticated.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Tests 5

Create and run automated API tests.

GET
/projects/{projectId}/apis/{apiId}/tests
APIGen List Tests
listTests 4 params → 200401
POST
/projects/{projectId}/apis/{apiId}/tests
APIGen Create a Test
createTest 2 params body → 201401422
GET
/projects/{projectId}/apis/{apiId}/tests/{testId}
APIGen Get a Test
getTest 3 params → 200401404
DELETE
/projects/{projectId}/apis/{apiId}/tests/{testId}
APIGen Delete a Test
deleteTest 3 params → 204401404
POST
/projects/{projectId}/apis/{apiId}/tests/{testId}/run
APIGen Run a Test
runTest 3 params → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are TestRun (9 properties), Test (8 properties), TestCase (4 properties), TestInput (4 properties). Each schema is shown below with its type and property counts.

Test
object
8 properties 6 required
TestRun
object
9 properties
TestInput
object
4 properties 2 required
TestCase
object
4 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apigen-tests-api-openapi.yml Raw ↑

Other APIs APIGen publishes across the network.

APIGen Connectors API
APIGen Deployments API
APIGen Endpoints API
APIGen Projects API
APIGen Schemas API
APIGen Tokens API
APIGen Users API