2017 © Pedro Peláez
 

library phpdraft

This is a parser for API Blueprint files in PHP.

image

smillerdev/phpdraft

This is a parser for API Blueprint files in PHP.

  • Friday, July 20, 2018
  • by SMillerDev
  • Repository
  • 2 Watchers
  • 22 Stars
  • 91 Installations
  • HTML
  • 0 Dependents
  • 0 Suggesters
  • 4 Forks
  • 4 Open issues
  • 50 Versions
  • 20 % Grown

The README.md

PHPDraft Packagist Version Sonar Quality Gate codecov FOSSA Status

This is a parser for API Blueprint files in PHP.1, (*1)

Dependencies

PHPDraft requires drafter to be installed. Refer to the drafter page for the installation details. If you don't want to install drafter, you can pass -o to the command to make it use https://api.apiblueprint.org/parser, (*2)

Usage

Requires PHP 8.1+ to run. Unittests require runkit or uopz For direct usage you can run:, (*3)

$ ./phpdraft.phar -f blueprint-file.apib > blueprint-webpage.html

You can also install it first:, (*4)

$ cp phpdraft.phar /usr/bin/phpdraft
$ chmod +x /usr/bin/phpdraft
$ phpdraft -f blueprint-file.apib > blueprint-webpage.html

Extra features

We got some fun stuff, check the wiki for more., (*5)

Writing API documentation

For writing API documentation using API Blueprint syntax. You can read about its specification., (*6)

Here's the example:, (*7)

FORMAT: 1A
HOST: https://api.example.com/v1

# Hello API

A simple API demo

# Group People

This section describes about the People

## Person [/people/{id}]

Represent particular Person

+ Parameters

    + id (required, string, `123`) ... The id of the Person.

+ Model (application/json)

    ```
    {"name":"Gesang","birthdate":"01-09-1917"}
    ```

### Retrieve Person [GET]

Return the information for the Person

+ Request (application/json)

    + Headers

        ```
        Authorization: Basic AbcdeFg=
        ```

+ Response 200 (application/json)

    [Person][]

Building an executable

Install the binary dependencies with composer (composer install). Run phing phar or phing phar-nightly, (*8)

Libraries

This app usage the following libraries: * https://github.com/michelf/php-markdown.git, (*9)

License

FOSSA Status, (*10)

The Versions

20/07 2018

dev-master

9999999-dev

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

18/06 2018

dev-include_fix

dev-include_fix

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

18/06 2018

1.13.3

1.13.3.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

04/05 2018

1.13.2

1.13.2.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

04/05 2018

dev-bootstrap/4.1

dev-bootstrap/4.1

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

04/05 2018

dev-hashes

dev-hashes

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

04/05 2018

1.13.1

1.13.1.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

04/05 2018

dev-table-fix

dev-table-fix

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

01/05 2018

dev-print_resource_desc

dev-print_resource_desc

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

01/05 2018

1.13

1.13.0.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

04/04 2018

1.0

1.0.0.0

  Sources   Download

04/04 2018

1.1

1.1.0.0

  Sources   Download

04/04 2018

1.1.1

1.1.1.0

  Sources   Download

04/04 2018

1.1.2

1.1.2.0

  Sources   Download

04/04 2018

1.2

1.2.0.0

  Sources   Download

04/04 2018

1.3

1.3.0.0

  Sources   Download

04/04 2018

1.3.1

1.3.1.0

  Sources   Download

04/04 2018

1.3.2

1.3.2.0

  Sources   Download

04/04 2018

1.3.3

1.3.3.0

  Sources   Download

04/04 2018

1.3.3.1

1.3.3.1

  Sources   Download

04/04 2018

1.3.3.2

1.3.3.2

  Sources   Download

04/04 2018

1.3.3.3

1.3.3.3

  Sources   Download

04/04 2018

1.3.4

1.3.4.0

  Sources   Download

04/04 2018

1.3.5

1.3.5.0

  Sources   Download

04/04 2018

1.3.5.1

1.3.5.1

  Sources   Download

04/04 2018

1.4

1.4.0.0

  Sources   Download

04/04 2018

1.4.1

1.4.1.0

  Sources   Download

04/04 2018

1.4.5

1.4.5.0

  Sources   Download

04/04 2018

1.4.5.1

1.4.5.1

  Sources   Download

04/04 2018

1.4.5.2

1.4.5.2

  Sources   Download

21/02 2018

dev-analysis-z4DMkD

dev-analysis-z4DMkD

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

20/02 2018

dev-analysis-8AllWP

dev-analysis-8AllWP

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

21/11 2017

1.12

1.12.0.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

16/10 2017

1.11.1

1.11.1.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

05/10 2017

1.11

1.11.0.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

10/08 2017

1.10

1.10.0.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

21/07 2017

1.9.2

1.9.2.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

21/07 2017

1.9.1

1.9.1.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

20/07 2017

1.9

1.9.0.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

03/06 2017

dev-dev/run

dev-dev/run

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

18/05 2017

1.9-beta.2

1.9.0.0-beta2

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

18/05 2017

1.9-beta

1.9.0.0-beta

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

05/05 2017

1.8.3

1.8.3.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

05/05 2017

1.8.2

1.8.2.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

04/05 2017

1.8.1

1.8.1.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

04/05 2017

1.8

1.8.0.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

by Sean Molenaar

08/02 2017

1.7.1

1.7.1.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

  • php >=5.4.0

 

The Development Requires

by Sean Molenaar

17/01 2017

1.7

1.7.0.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

  • php >=5.4.0

 

The Development Requires

by Sean Molenaar

19/12 2016

1.6

1.6.0.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

  • php >=5.4.0

 

The Development Requires

by Sean Molenaar

18/11 2016

1.5

1.5.0.0

This is a parser for API Blueprint files in PHP.

  Sources   Download

GPL-3.0

The Requires

  • php >=5.4.0

 

The Development Requires

by Sean Molenaar