Skip to main content

Developer overview

This section is the developer entry point for building with APIEase as code.

For most teams, the recommended path starts with apiease-template, uses apiease-cli for day-to-day operations, and reaches for the APIEase Public API only when direct HTTP automation is the better fit.

If you are new to this workflow, start with Quickstart with apiease-template.

Use this reading order when you are getting started:

  1. Why use the template to understand why apiease-template is the recommended starting point
  2. Quickstart with apiease-template to initialize the project, configure auth, and sync resources
  3. apiease-template to understand the repository layout and what belongs in source control
  4. apiease-cli for the command-line workflow that manages saved resources
  5. APIEase Public API when you need lower-level HTTP integration
  6. Using APIEase with AI agents when Codex-style agents will work inside the repository

Choose the right page​

Use these pages based on the job you need to do:

How this fits the rest of the docs​

The Developers section focuses on the developer workflow around repositories, the CLI, and the public API.

For request behavior, request contracts, and other platform concepts, use the existing docs instead of treating this section as a duplicate reference:

Practical workflow summary​

In the intended workflow, you initialize a repository from the template, keep resource definitions in git, use apiease-cli to sync them with APIEase, and use the public API directly only when you need lower-level automation outside the normal CLI path.