alpaca

Installation

# Clone the project into your golang workspace$ git clone git://github.com/pksunkara/alpaca$cd alpaca# Install program$ make&& make install

Examples

Usage

$ alpaca</path/to/dir>

Usage:  alpaca [options] <dir>Application Options:  -v, --version    Show version informationLanguage Options:      --no-php     Do not write php library      --no-python  Do not write python library      --no-ruby    Do not write ruby library      --no-node    Do not write node libraryHelp Options:  -h, --help       Show this help message

pkg.json

{"name":"Example",// Name of the api (also used as class name for the library)"package":"example-alpaca",// Name of the package"version":"0.1.0",// Version of the package"url":"https://exampleapp.com",// URL of the api"keywords":["alpaca","exampleapp","api"],// Keywords for the package"official":false,// Are the api libraries official?"author":{"name":"Pavan Kumar Sunkara",// Name of the package author"email":"pavan.sss1991@gmail.com",// Email of the package author"url":"http://github.com/pksunkara"// URL of the package author},"git":{// Used in the package definition"site":"github.com",// Name of the git website"user":"alpaca-api",// Username of the git website"name":"buffer"// Namespace of the git repositories},"license":"MIT",// License of the package"php":{// Required only if creating php api lib"vendor":"pksunkara"// Packagist vendor name for the package},"python":{// Required only if creating python api lib"license":"MIT License"// Classifier of the license used for the module}}

api.json

{"base":"https://exampleapp.com",// Base URL of the api"base_as_arg":true,// Force Base URL to be an argument in generated clients [optional] (default: false)"version":"v1",// Default version for the api (https://api.example.com{/version}/users) [optional]"no_verify_ssl":true,// Do not verify SSL cert [optional] (default: false)"authorization":{// Authorization strategies"need_auth":true,// Authentication is compulsory [optional] (default: false)"basic" :true,// Basic authentication [optional] (default: false)"header":true,// Token in authorization header [optional] (default: false)"header_prefix":"oompaloompa",// The first word in header if using token auth header [optional] (default: token)"oauth" :true// OAUTH authorization [optional] (default: false)},"request":{// Settings for requests to the api"formats":{// Format of the request body"default":"form",// Default format for the request body [optional] (default: raw)"form":true,// Support form-url-encoded? [optional] (default: false)"json":true// Support json? [optional] (default: false)}},"response":{// Settings for responses from the api"suffix":true,// Should the urls be suffixed with response format? [optional] (default: false)"formats":{// Format of the response body"default":"json",// Default response format. Used when 'suffix' is 'true'"html":true,// Support html? [optional] (default: false)"json":true// Support json? [optional] (default: false)}},"error":{// Required if response format is 'json'"message":"error"// The field to be used from the response body for error message},"class":{// The classes for the api"users":{// Name of a class of the api"args":["login"],// Arguments required for the api class [optional]"profile":{// Name of a method of the api"path":"/users/:login/:type",// URL of the api method"method":"post",// HTTP method of the api method [optional] (default: get)"params":[// Parameters for the api method [optional]{"name":"type",// Name of the parameter"required":true,// The parameter will become an argument of api method [optional] (default: false)"url_use":true// This parameter is only used to build url [optional] (default: false)},{"name":"bio","required":true}]}}}}

doc.json

{"users":{// Name of a class of the api"title":"Users",// Title of the api class"desc":"Returns user api instance",// Description of the api class"args":{// Arguments of the api class"login":{// Name of the argument"desc":"Username of the user",// Description of the argument"value":"pksunkara"// Value of the argument in docs}},"profile":{// Name of a method of the api"title":"Edit profile",// Title of the api method"desc":"Edit the user's profile",// Description of the api method"params":{// Parameter of the api class"bio":{// Name of the parameter"desc":"Short bio in profile",// Description of the parameter"value":"I am awesome!"// Value of the parameter in docs},"type":{"desc":"Circle of the profile","value":"friends"}}}}}

Request formats

Response formats

Authorization strategies

Language Versions

Package Managers

Testing

Contributors

TODO

Responses

Requests

API

Libraries

Readme

Comments

Formats

Languages

Support Projects

License

Bug Reports

Contact