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 Projects API

Manage API generation projects.

APIGen Projects 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 Projects. 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 10 operations across 4 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.

10 operations 4 paths 5 schemas 2 DELETE4 GET2 POST2 PUT

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 Projects 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 10

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

Projects 10

Manage API generation projects.

GET
/projects
APIGen List Projects
listProjects 2 params → 200401
POST
/projects
APIGen Create a Project
createProject body → 201401422
GET
/projects/{projectId}
APIGen Get a Project
getProject 1 param → 200401404
PUT
/projects/{projectId}
APIGen Update a Project
updateProject 1 param body → 200401404422
DELETE
/projects/{projectId}
APIGen Delete a Project
deleteProject 1 param → 204401404
GET
/projects/{projectId}/apis
APIGen List APIs in a Project
listApis 3 params → 200401
POST
/projects/{projectId}/apis
APIGen Create an API
createApi 1 param body → 201401422
GET
/projects/{projectId}/apis/{apiId}
APIGen Get an API
getApi 2 params → 200401404
PUT
/projects/{projectId}/apis/{apiId}
APIGen Update an API
updateApi 2 params body → 200401404422
DELETE
/projects/{projectId}/apis/{apiId}
APIGen Delete an API
deleteApi 2 params → 204401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Api (9 properties), Project (6 properties), ApiInput (5 properties), ProjectInput (2 properties). Each schema is shown below with its type and property counts.

ApiInput
object
5 properties 1 required
ProjectInput
object
2 properties 1 required
Project
object
6 properties 5 required
Api
object
9 properties 7 required
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apigen-projects-api-openapi.yml Raw ↑

Other APIs APIGen publishes across the network.

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