Home

Welcome to the SpecAPI wiki, if you have no idea what SpecAPI is, you should look at the README.md in the root project that provides a quick overview and quick start guide then come back here to learn more.

SpecAPI is a specification language to define the available methods, request signatures and response signatures of a Web API such as the Github API.

Once you have a written a specification using the SpecAPI language you can then use plugins to generate assets such as platform specific Web API client source code, server-side contracts and documentation.

Contents

• Installation
• Language Syntax
• SpecAPI Command Line
• Eclipse IDE
• Sublime Text 2
• Plugin Development