capabilities.work

Create an API with a Schema

A 3-step recipe with Postman. We can help you get access.

Recipe · 3 steps

Create an API with a Schema

with Postman

Create an API, version it, and attach an OpenAPI schema.

  1. Create the API in the supplied workspace.
  2. Create a named version of the API.
  3. Attach an OpenAPI 3.1 schema, in YAML, to the API.
What you'll need to have ready
  • workspace: The workspace ID to create the API in.
  • apiName: The name of the API to create.
  • apiSummary: A brief summary for the API.
  • versionName: The version name to create (e.g. 1.0.0).
  • schemaContent: The OpenAPI schema content as a YAML string.
For your developer

Arazzo workflow postman:create-api-with-schema, 3 operations: createApi → createApiVersion → createApiSchema. Specs on APIs.io.

More recipes with Postman

Stand Up an API Testing PipelineBootstrap a WorkspaceCollection LifecycleCreate and Run a MonitorCreate a Mock Server from a CollectionEnvironment LifecycleFork and Merge a CollectionInspect an API SchemaInspect Collection ContentsAudit Mock Server Call Logs