Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hitode909/apischema
Schema for API
https://github.com/hitode909/apischema
Last synced: 3 months ago
JSON representation
Schema for API
- Host: GitHub
- URL: https://github.com/hitode909/apischema
- Owner: hitode909
- License: other
- Created: 2015-02-18T10:26:26.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2021-03-18T09:28:02.000Z (almost 4 years ago)
- Last Synced: 2024-06-21T16:51:31.225Z (6 months ago)
- Language: Perl
- Homepage:
- Size: 119 KB
- Stars: 13
- Watchers: 3
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: Changes
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/hitode909/APISchema)
# NAME
APISchema - Schema for API
# SYNOPSIS
# bmi.def
resource figure => {
type => 'object',
description => 'Figure, which includes weight and height',
properties => {
weight => {
type => 'number',
description => 'Weight(kg)',
example => 50,
},
height => {
type => 'number',
description => 'Height(m)',
example => 1.6,
},
},
required => ['weight', 'height'],
};
resource bmi => {
type => 'object',
description => 'Body mass index',
properties => {
value => {
type => 'number',
description => 'bmi value',
example => 19.5,
},
},
required => ['value'],
};
POST '/bmi/' => {
title => 'BMI API',
description => 'This API calculates your BMI.',
destination => {
controller => 'BMI',
action => 'calculate',
},
request => 'figure',
response => 'bmi',
};
# main.pl
use APISchema::DSL;
my $schema = APISchema::DSL::process {
include 'bmi.def';
};
# Routing
use APISchema::Generator::Router::Simple;
my $router = do {
my $generator = APISchema::Generator::Router::Simple->new;
$generator->generate_router($schema);
};
# Inject routes to an existing router object
my $router = Router::Simple->new;
$router->connect(...);
my $generator = APISchema::Generator::Router::Simple->new;
$generator->inject_routes($schema => $router);
# Documentation
use APISchema::Generator::Markdown;
print do {
my $generator = APISchema::Generator::Markdown->new;
$generator->format_schema($schema);
};
# Middleware (in app.psgi)
enable "APISchema::ResponseValidator", schema => $schema;
enable "APISchema::RequestValidator", schema => $schema;
# DESCRIPTION
APISchema is Schema for API
It provides DSL to describe API specification schema.
It generates router, validator, document from API schema.
# LICENSE
Copyright (C) hitode909 and tarao.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
# AUTHORS
hitode909
tarao