Home

API-Flow

The goal of API-Flow is to help users discover REST APIs by seamlessly transforming any of the many API description formats into the one they actually use, be it a list of curl requests, a swagger, a RAML file, etc. No description format is perfect, and each implements that sweet feature better than the others, making each attractive to different users for different use cases. As a result, the API world is divided by its formats, and we're most likely missing on some awesome apps just because of it.

No human should have to suffer through the conversion of a curl requests list into a RAML/Swagger file. API-Flow tries to put back together this fragmented universe, and let humans do what they do best: human work.

API-Flow is an open source initiative led by Paw that currently supports cURL, Swagger, RAML and Postman files as inputs and no format as output. It will be available as a CLI through npm, as well as a Web service.

Installation (Not yet available)

Installing API-Flow CLI is as simple as it gets:

npm install api-flow -g

Using API-Flow as an npm module:

npm install api-flow --save

Table of Contents

Core Model

Core Structure components

• Api
• Auth
• Constraint
• Context
• Group
• Request
• Response
• Body
• Parameter
• ParameterContainer
• ReferenceContainer

Miscellaneous

• Info
• Contact
• License
• URL

Parsers

• Swagger
• RAML
• cURL
• Postman

Resolvers

• Resolver

Node

• RemoteResolver
• FileResolver
• JSONResolver
• XMLResolver

Web

Paw

Serializers

Paw

• BaseExporter
• cURL
• Swagger
• Postman
• RAML

Others

• BaseSerializer
• cURL
• Swagger
• Postman
• RAML