Package Exports
- @antelopejs/interface-api
- @antelopejs/interface-api/antelope.test
- @antelopejs/interface-api/index
- @antelopejs/interface-api/package.json
- @antelopejs/interface-api/tests/index.test
Readme
Interface API
A powerful, decorator-based framework for building HTTP services with TypeScript. Interface API simplifies the process of defining routes, handling requests, and generating responses using a clean, declarative syntax.
Installation
ajs module imports add api@betaDocumentation
Detailed documentation is available in the docs directory:
- Introduction - Overview and basic concepts
- Controllers - Creating and using API controllers
- HTTP Handling - Request and response handling
- Parameter Handling - Working with parameters
Current Status
This is the development version (beta) of the Interface API. It is currently in pre-release stage and may undergo changes before the final release. The interface is not considered stable for production use without understanding that breaking changes may occur.
Versions
| Version | Link | Status |
|---|---|---|
| beta | api@beta | Waiting validation from community to go in v1 |
| 1 | Not yet released | Planned stable release |
License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.