Praxis is a framework that focuses on both the design and implementation aspects of creating APIs.
Clone or download
blanquer Fix and improve Doc Browser presentation: (#325)
* Pass at DocBrowser to:
  * proper showing of substructures of payloads
  * mark required attrs with red star (and semi-required as orange)
  * display the existing special requirements as well
  * Added requirements for parameters as well (in addition to payload)
  * format member_options display better

* Annotate Changelog changes
* Initialize `MiddleWareApp` lazily
This allows the main rack app (i.e., Rails) to be fully initialized by the time any code in the Praxis middleware gets touched (i.e., full ActiveRecord connection initialization...etc.)

* updated the ruby versions and force the right node version
* comment the doc browser tests for travis altogether (until updated deps)
  * Fix for travis-ci/travis-ci#8978
* Changed some of the badges to point to the Praxis org
Latest commit 37b97f2 Jan 10, 2018

README.md

Praxis TravisCI Coverage Status

Praxis is a framework for both designing and implementing APIs.

An important part of the framework is geared towards the design aspect of building an API. This functionality empowers architects with tools to design every last aspect of their API, resulting in a complete, web-browsable documentation, which includes automatic generation of examples for resources, parameters, headers, etc...as well as requests and responses for the supported encodings. The design process is iterative, and flows from defining new resources, parameters, etc...to reviewing the resulting docs (usually with some of the potential clients of the API), back to updating the design based on feedback, or expanding it with more resources. The design language (i.e. DSL) of Praxis follows a clean 'ruby-type-syntax' and its final outcome is to generates an output that is both a set of schema documents as well as a web-based API browser (driven by those schemas). This allows Praxis to design APIs that can potentially be implemented in any language.

Another important part of the framework is geared towards helping in the implementation of the API service. In particular, Praxis provides help to Ruby developers for building a service conforming to the designed API. Aside from Ruby there is also sister-project called Goa that assists in implementing Praxis-like design API using Golang. Since the API design generates schema files very similar in nature to other API document formats like (Swagger, Google Discovery, RAML, etc...) supporting other implementation languages could be easily accomplished in the future by building converters to/from them.

The part of the framework that helps with the ruby service implementation takes an approach that is different from other existing ruby (micro)frameworks such as Grape, Sinatra, Scorched, Lotus or even RailsAPI (now part of Rails). Instead of being developer-centric, it takes an integrated approach treating both designers and implementors as first class citizens throughout the complete API building process. With Praxis you create an API by iterating through the design, review and implementation phases. While Praxis can help Ruby developers in a lot of aspects involved in building a service, the framework is completely componentized as to allow developers to pick and choose which parts to use, which ones not to use, and which other technologies to integrate with. The framework provides help in many areas, for example: all aspects of request and response validation, automatic type-coercion, consistent error-responses, routing and url generation, advanced template/media-type definition and rendering, domain-modeling, optional database ORM (for high-perfomance large datasets), DB integration (with an efficient identityMap), a plugin and extensible framework to easily hook into, available integrations such as newrelic, statsd, etc...

There is a long list of benefits that come from using Praxis. From those, here are a couple of the salient themes:

  • Designing APIs with Praxis result in a very precise, consistent and beautiful API documentation that it is apt for both human (web browsable) or machine consumption (JSON spec files).
  • Building Ruby APIs with Praxis will result in much faster developer times, and more importantly with a resulting service that will ensure that its implementation is always consistent with its design, and it is enforced at all times.

Quickstart

# Install the praxis gem
gem install praxis

# Generate a praxis application named my-app in ./my-app
praxis example my-app

# Run it!
cd my-app
bundle
rackup

Or better yet, checkout a simple, but functional blog example app which showcases a few of the main design and implementation aspects that Praxis has to offer.

Mailing List

Join our Google Groups for discussion, support and announcements.

Join our slack support and general announcements channel for on-the-spot answers to your questions:

And follow us on twitter: @praxisapi

Contributions

Contributions to make Praxis better are welcome. Please refer to CONTRIBUTING for further details on what contributions are accepted and how to go about contributing.

Requirements

Praxis requires Ruby 2.1.0 or greater.

License

This software is released under the MIT License. Please see LICENSE for further details.

Copyright (c) 2014 RightScale