README
¶
compose
Warning: This package is still in development and things keep changing so things may break slightly
A collection of opinionated modules created for building golang applications quicker while keeping best practices.
Why
Most applications have many components in common:
- Loading config & env variables
- Logging
- Keeping a state
- Long term storage
- APIs
- Authentication
- Role management
In the spirit of keeping it DRY, this package standardizes everything so we can use the same components on every application.
Instalation
go get -u github.com/vanclief/compose
Usage
- config - Loading env/ settings
Dependencies
Directories
¶
| Path | Synopsis |
|---|---|
|
components
|
|
|
mcp
Package mcp exposes a REST API described by an OpenAPI 3.x document as a Model Context Protocol server with a fixed set of tools:
|
Package mcp exposes a REST API described by an OpenAPI 3.x document as a Model Context Protocol server with a fixed set of tools: |
|
mcp/oauth
Package oauth lets hosted MCP clients such as claude.ai and ChatGPT connect to a compose MCP server.
|
Package oauth lets hosted MCP clients such as claude.ai and ChatGPT connect to a compose MCP server. |
|
rest/generator
Package generator derives an OpenAPI 3.0 document from the source of an Echo application built on compose's rest handlers.
|
Package generator derives an OpenAPI 3.0 document from the source of an Echo application built on compose's rest handlers. |
|
rest/reference
Package reference renders an OpenAPI 3.x document as a self-hosted API reference page: an alternative to Scalar and Redoc that ships inside the backend, with no CDN assets.
|
Package reference renders an OpenAPI 3.x document as a self-hosted API reference page: an alternative to Scalar and Redoc that ships inside the backend, with no CDN assets. |
|
drivers
|
|
|
integrations
|
|
|
primitives
|
|
|
enums
Package enums validates string-backed enums and adapts them to JSON and database/sql.
|
Package enums validates string-backed enums and adapts them to JSON and database/sql. |
|
utils
|
|
Click to show internal directories.
Click to hide internal directories.