https://github.com/smillerdev/phpdraft

An API Blueprint parser in PHP
https://github.com/smillerdev/phpdraft

api-blueprint apiary drafter php

Last synced: 1 day ago
JSON representation

An API Blueprint parser in PHP

• Host: GitHub
• URL: https://github.com/smillerdev/phpdraft
• Owner: SMillerDev
• License: gpl-3.0
• Created: 2016-08-07T18:29:07.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-12-12T20:19:40.000Z (11 days ago)
• Last Synced: 2024-12-12T21:23:13.804Z (11 days ago)
• Topics: api-blueprint, apiary, drafter, php
• Language: HTML
• Size: 1.18 MB
• Stars: 38
• Watchers: 3
• Forks: 6
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# PHPDraft [![Packagist Version](https://img.shields.io/packagist/v/smillerdev/phpdraft.svg)](https://github.com/SMillerDev/phpdraft/releases/latest) [![Sonar Quality Gate](https://img.shields.io/sonar/https/sonarcloud.io/SMillerDev_phpdraft/alert_status.svg)](https://sonarcloud.io/dashboard?id=SMillerDev_phpdraft) [![codecov](https://codecov.io/gh/SMillerDev/phpdraft/branch/master/graph/badge.svg?token=2IPSlcCwXM)](https://codecov.io/gh/SMillerDev/phpdraft) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FSMillerDev%2Fphpdraft.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FSMillerDev%2Fphpdraft?ref=badge_shield)

This is a parser for API Blueprint files in PHP.[1](#dependencies)

## Dependencies

PHPDraft requires [drafter](https://github.com/apiaryio/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](https://api.apiblueprint.org/parser)

## Usage

Requires PHP 8.1+ to run. Unittests require runkit or uopz

For direct usage you can run:

```bash

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

```

You can also install it first:

```bash

$ 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](https://github.com/SMillerDev/phpdraft/wiki) for more.

## Writing API documentation

For writing API documentation using [API Blueprint](http://apiblueprint.org/) syntax. You can read about its [specification](https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md).

Here's the example:

```markdown

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`

## Libraries

This app usage the following libraries:

* https://github.com/michelf/php-markdown.git

## License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FSMillerDev%2Fphpdraft.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FSMillerDev%2Fphpdraft?ref=badge_large)