Giter VIP home page Giter VIP logo

hapi's Introduction

Hapi

Hapi is a low-level API client architecture for Crystal, specifically for JSON REST APIs. Hapi revolves around the following concepts:

  1. Resource:

    A Resource represents a JSON-serializable object that can be retrieved in responses from the API server.

  2. Client:

    A Client is responsible for querying all resource endpoints, and returning responses from the API server.

  3. Endpoint

    An Endpoint is a queryable path exposed by the API server, that returns a response. In Hapi, an endpoint represents a single resource endpoint, with methods that operate on its individual sub-endpoints.

  4. Response:

    A Response is Hapi's representation of the raw response body received from the API server. It is a type-safe wrapper around the JSON response object.

    A Response may be an Item (a single resource object), or a List (an array of resource objects)

Usage

See spec/support/ directory of this repository for example usage.

Example Projects

The following Crystal libraries use Hapi:

Development

Run specs with crystal spec.

Contributing

  1. Fork it
  2. Switch to the master branch: git checkout master
  3. Create your feature branch: git checkout -b my-new-feature
  4. Make your changes, updating changelog and documentation as appropriate.
  5. Commit your changes: git commit
  6. Push to the branch: git push origin my-new-feature
  7. Submit a new Pull Request against the GrottoPress:master branch.

hapi's People

Contributors

akadusei avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.