granite-api

Version, currently master branch1 version
  • master branchlatestApr 1, 2025

github.com/spoved/granite-api.cr

A framework to generate open-api servers from granite models

2 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  granite-api:
    github: spoved/granite-api.cr
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
1.1.1
License
MIT
Author
Holden Omans

Dependencies

Runtime Dependencies

  • jwt*github: crystal-community/jwt
  • kemal*github: kemalcr/kemal
  • tablo~> 0.10.1github: hutou/tablo
  • spoved*github: spoved/spoved.cr
  • granite*github: kalinon/granite, branch: kalinon
  • open-api>= 0.2.9github: spoved/open-api.cr

Development Dependencies

  • mysql*github: crystal-lang/crystal-mysqldev
  • sqlite3*github: crystal-lang/crystal-sqlite3dev
  • spec-kemal*github: kemalcr/spec-kemaldev

README

granite-api

A framework to generate open-api servers from granite models

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
      granite-api:
        github: spoved/granite-api.cr
  2. Run shards install

Usage

require "granite-api"

TODO: Write usage instructions here

Development

TODO: Write development instructions here

Contributing

  1. Fork it (https://github.com/spoved/granite-api.cr/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors