Skip to content

Commit d7a10a0

Browse files
SMillerDevSMillerDev
authored
feat: generate OpenAPI JSON from APIB (#602)
1 parent 71bb7ec commit d7a10a0

18 files changed

+1058
-338
lines changed

‎.github/workflows/test.yml

+83
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,89 @@ jobs:
8585
name: coverage-${{ matrix.php-versions }}
8686
path: coverage.xml
8787

88+
openapi:
89+
name: File generation
90+
needs: test
91+
runs-on: ubuntu-latest
92+
env:
93+
PHPDRAFT_THIRD_PARTY: 1
94+
extensions: curl,json,mbstring,uopz
95+
key: cache-v1 # can be any string, change to clear the extension cache.
96+
strategy:
97+
matrix:
98+
php-versions: [ '8.3' ]
99+
steps:
100+
- name: Checkout
101+
uses: actions/checkout@v4
102+
with:
103+
fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
104+
105+
- name: Setup cache environment
106+
id: extcache
107+
uses: shivammathur/cache-extensions@v1
108+
with:
109+
php-version: ${{ matrix.php-versions }}
110+
extensions: ${{ env.extensions }}
111+
key: ${{ env.key }}
112+
113+
- name: Cache extensions
114+
uses: actions/cache@v4
115+
with:
116+
path: ${{ steps.extcache.outputs.dir }}
117+
key: ${{ steps.extcache.outputs.key }}
118+
restore-keys: ${{ steps.extcache.outputs.key }}
119+
120+
- name: Setup PHP
121+
uses: shivammathur/setup-php@v2
122+
with:
123+
php-version: ${{ matrix.php-versions }}
124+
extensions: ${{ env.extensions }}
125+
coverage: pcov
126+
tools: pecl,phpunit
127+
128+
- name: Get Composer Cache Directory
129+
id: composer-cache
130+
run: echo "dir=$(composer config cache-files-dir)" >> "$GITHUB_OUTPUT"
131+
132+
- name: Cache dependencies
133+
uses: actions/cache@v4
134+
with:
135+
path: ${{ steps.composer-cache.outputs.dir }}
136+
key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
137+
restore-keys: ${{ runner.os }}-composer-
138+
139+
- name: Validate composer.json and composer.lock
140+
run: composer validate
141+
142+
- name: Install dependencies
143+
run: composer install --prefer-dist --no-progress --ignore-platform-reqs
144+
145+
- name: Generate OpenAPI definition and HTML
146+
run: php ./phpdraft --online --file tests/statics/full_test.apib --openapi openapi.json > out.html 2> error.txt || true
147+
148+
- name: Install check-jsonschema
149+
run: pipx install check-jsonschema
150+
151+
- name: Validate OpenAPI spec
152+
run: |
153+
if [ -s "error.txt" ]; then
154+
echo "The file 'error.txt' is not empty."
155+
cat error.txt
156+
exit 1
157+
fi
158+
159+
if [ ! -s "index.html" ]; then
160+
echo "The file 'index.html' is empty."
161+
exit 1
162+
fi
163+
164+
if [ ! -s "openapi.json" ]; then
165+
echo "The file 'openapi.json' is empty."
166+
exit 1
167+
fi
168+
169+
check-jsonschema --schemafile https://spec.openapis.org/oas/3.1/schema/latest openapi.json
170+
88171
analytics:
89172
name: Analytics
90173
needs: test

‎.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
/build/out
1212
/build/*.phar
1313
/tests/statics/index.*
14-
src/Michelf/*
1514
src/.gitignore
1615
vendor/**
1716

@@ -21,6 +20,8 @@ atlassian-ide-plugin.xml
2120
*.pem
2221

2322
/index.html
23+
/openapi.json
2424

2525
/coverage.xml
2626
/event.json
27+
!/src/PHPDraft/Out/

‎phpdraft

+6
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ try
2828
->opt('help:h', 'This help text', false)
2929
->opt('version:v', 'Print the version for PHPDraft.', false)
3030
->opt('file:f', 'Specifies the file to parse.', false)
31+
->opt('openapi:a', 'Output location for an OpenAPI file.', false)
3132
->opt('yes:y', 'Always accept using the online mode.', false, 'bool')
3233
->opt('online:o', 'Always use the online mode.', false, 'bool')
3334
->opt('template:t', 'Specifies the template to use. (defaults to \'default\').', false)
@@ -90,6 +91,11 @@ try
9091
$data = json_decode($json_string);
9192
}
9293

94+
if (isset($args['openapi'])) {
95+
$openapi = ParserFactory::getOpenAPI()->init($data);
96+
$openapi->write($args['openapi']);
97+
}
98+
9399
$html = ParserFactory::getJson()->init($data);
94100
$name = 'PHPD_SORT_' . strtoupper($args->getOpt('sort', ''));
95101
$html->sorting = Sorting::${$name} ?? Sorting::PHPD_SORT_NONE->value;

‎src/PHPDraft/Model/HTTPRequest.php

+5-3
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212

1313
namespace PHPDraft\Model;
1414

15+
use PHPDraft\Model\Elements\ObjectStructureElement;
1516
use PHPDraft\Model\Elements\RequestBodyElement;
1617
use PHPDraft\Model\Elements\StructureElement;
1718

@@ -43,7 +44,7 @@ class HTTPRequest implements Comparable
4344
*
4445
* @var string
4546
*/
46-
public string $description;
47+
public string $description = '';
4748

4849
/**
4950
* Parent class.
@@ -68,9 +69,10 @@ class HTTPRequest implements Comparable
6869
/**
6970
* Structure of the request.
7071
*
71-
* @var RequestBodyElement[]|RequestBodyElement
72+
* @var RequestBodyElement[]|RequestBodyElement|ObjectStructureElement
7273
*/
73-
public mixed $struct = [];
74+
public RequestBodyElement|ObjectStructureElement|array|null $struct = [];
75+
7476
/**
7577
* Identifier for the request.
7678
*

‎src/PHPDraft/Model/Transition.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ class Transition extends HierarchyElement
2323
/**
2424
* HTTP method used.
2525
*
26-
* @var string
26+
* @var string|null
2727
*/
28-
public string $method;
28+
public ?string $method = NULL;
2929

3030
/**
3131
* URI.

‎src/PHPDraft/Out/BaseTemplateRenderer.php

+42-22
Original file line numberDiff line numberDiff line change
@@ -24,36 +24,21 @@ abstract class BaseTemplateRenderer
2424
* @var int
2525
*/
2626
public int $sorting;
27+
2728
/**
28-
* CSS Files to load.
29-
*
30-
* @var string[]
31-
*/
32-
public array $css = [];
33-
/**
34-
* JS Files to load.
35-
*
36-
* @var string[]
37-
*/
38-
public array $js = [];
39-
/**
40-
* The image to use as a logo.
41-
*
42-
* @var string|null
43-
*/
44-
protected ?string $image = null;
45-
/**
46-
* The template file to load.
29+
* JSON representation of an API Blueprint.
4730
*
48-
* @var string
31+
* @var object
4932
*/
50-
protected string $template;
33+
protected object $object;
34+
5135
/**
5236
* The base data of the API.
5337
*
5438
* @var array<string, mixed>
5539
*/
56-
protected array $base_data;
40+
protected array $base_data = [];
41+
5742
/**
5843
* JSON object of the API blueprint.
5944
*
@@ -66,4 +51,39 @@ abstract class BaseTemplateRenderer
6651
* @var BasicStructureElement[]
6752
*/
6853
protected array $base_structures = [];
54+
55+
/**
56+
* Parse base data
57+
*
58+
* @param object $object
59+
*/
60+
protected function parse_base_data(object $object): void
61+
{
62+
//Prepare base data
63+
if (!is_array($object->content[0]->content)) {
64+
return;
65+
}
66+
67+
$this->base_data['TITLE'] = $object->content[0]->meta->title->content ?? '';
68+
69+
foreach ($object->content[0]->attributes->metadata->content as $meta) {
70+
$this->base_data[$meta->content->key->content] = $meta->content->value->content;
71+
}
72+
73+
foreach ($object->content[0]->content as $value) {
74+
if ($value->element === 'copy') {
75+
$this->base_data['DESC'] = $value->content;
76+
continue;
77+
}
78+
79+
$cat = new Category();
80+
$cat = $cat->parse($value);
81+
82+
if (($value->meta->classes->content[0]->content ?? null) === 'dataStructures') {
83+
$this->base_structures = array_merge($this->base_structures, $cat->structures);
84+
} else {
85+
$this->categories[] = $cat;
86+
}
87+
}
88+
}
6989
}

‎src/PHPDraft/Out/TemplateRenderer.php ‎src/PHPDraft/Out/HtmlTemplateRenderer.php

+29-36
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,36 @@
3131
use Twig\TwigFilter;
3232
use Twig\TwigTest;
3333

34-
class TemplateRenderer extends BaseTemplateRenderer
34+
class HtmlTemplateRenderer extends BaseTemplateRenderer
3535
{
36+
37+
38+
/**
39+
* CSS Files to load.
40+
*
41+
* @var string[]
42+
*/
43+
public array $css = [];
44+
45+
/**
46+
* JS Files to load.
47+
*
48+
* @var string[]
49+
*/
50+
public array $js = [];
51+
/**
52+
* The image to use as a logo.
53+
*
54+
* @var string|null
55+
*/
56+
protected ?string $image = null;
57+
/**
58+
* The template file to load.
59+
*
60+
* @var string
61+
*/
62+
protected string $template;
63+
3664
/**
3765
* TemplateGenerator constructor.
3866
*
@@ -109,41 +137,6 @@ public function get(object $object): string
109137
]);
110138
}
111139

112-
/**
113-
* Parse base data
114-
*
115-
* @param object $object
116-
*/
117-
private function parse_base_data(object $object): void
118-
{
119-
//Prepare base data
120-
if (!is_array($object->content[0]->content)) {
121-
return;
122-
}
123-
124-
$this->base_data['TITLE'] = $object->content[0]->meta->title->content ?? '';
125-
126-
foreach ($object->content[0]->attributes->metadata->content as $meta) {
127-
$this->base_data[$meta->content->key->content] = $meta->content->value->content;
128-
}
129-
130-
foreach ($object->content[0]->content as $value) {
131-
if ($value->element === 'copy') {
132-
$this->base_data['DESC'] = $value->content;
133-
continue;
134-
}
135-
136-
$cat = new Category();
137-
$cat = $cat->parse($value);
138-
139-
if (($value->meta->classes->content[0]->content ?? null) === 'dataStructures') {
140-
$this->base_structures = array_merge($this->base_structures, $cat->structures);
141-
} else {
142-
$this->categories[] = $cat;
143-
}
144-
}
145-
}
146-
147140
/**
148141
* Get the path to a file to include.
149142
*

0 commit comments

Comments
 (0)