Skip to content

Adding some more information to the request template #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
malteriesch wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Adding some more information to the request template #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0926a68
Added Formdata type and example value for type = file
malteriesch Jul 6, 2018
59fa498
Added response's form data and json to the template
malteriesch Jul 10, 2018
b218090
Added default status code if it is missing (for example when generati…
malteriesch Jul 10, 2018
e4e59c7
Added the method and urls to each response example
malteriesch Jul 10, 2018
8627d94
adding the folder name to the generated file name of the request to a…
malteriesch Jul 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion Command/GenerateCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
$request->request->url = $request->request->url->raw;
}
$pageFilename = strtolower($request->request->method) . '_' . str_ireplace(array('/','\\','.',' ','?'),'_', $request->name) . ".html";
$request->page_path = 'requests/' . $pageFilename;
$request->page_path = 'requests/' . $item->name. '-' . $pageFilename;
if (!property_exists($request, 'response') || !count($request->response)) {
$output->writeln("Warning: {$request->name} has no response examples");
}
Expand All @@ -89,6 +89,10 @@ protected function execute(InputInterface $input, OutputInterface $output)
}

foreach ($request->response as $key => $response) {
if (!property_exists($response, 'code')) {
$response->code = 200;
}

if ($response->code >=100 && $response->code <200) {
$response->class = 'info';
} elseif ($response->code >=200 && $response->code <300) {
Expand Down Expand Up @@ -154,6 +158,11 @@ protected function getTwig()
});

$twig->addFunction($f);

$twig->addFunction(new \Twig_SimpleFunction("upper", function ($data) {
return strtoupper($data);
}));

return $twig;
}

Expand Down
44 changes: 43 additions & 1 deletion templates/request.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ <h1> {{request.name}} </h1>
<th>Example Value</th>
</tr>
</thead>
{% for parameter in request.request.body.formdata %}
{% for parameter in request.request.response.body.formdata %}
<tr>
<td>{{parameter.key}}</td>
<td>{{parameter.type}}</td>
Expand Down Expand Up @@ -90,6 +90,48 @@ <h2>Example responses</h2>
{% for response in request.response %}
<div class="panel panel-{{response.class}}">
<div class="panel-heading">{{response.name}}</div>
<div class="panel ">
<div class="panel-heading">
<strong>{{upper(response.originalRequest.method)}}</strong> {{response.originalRequest.url.raw}}
</div>
</div>
{% if response.originalRequest.method != 'GET' %}
{% if response.originalRequest.body.mode == 'formdata' %}
<div class="panel panel-default">
<div class="panel-heading">Form-data Parameters </div>
<div class="panel-body">
<table class="table table-hover ">
<thead>
<tr>
<th>Key</th>
<th>Type</th>
<th>Example Value</th>
</tr>
</thead>
{% for parameter in response.originalRequest.body.formdata %}
<tr>
<td>{{parameter.key}}</td>
<td>{{parameter.type}}</td>
{% if parameter.type == 'file' %}
<td>{{parameter.src}}</td>
{% else %}
<td>{{parameter.value}}</td>
{% endif %}
</tr>
{% endfor %}
</table>
</div>
</div>
{% endif %}
{% if response.originalRequest.body.mode == 'raw' %}
<div class="panel panel-default">
<div class="panel-heading">JSON</div>
<div class="panel-body">
<pre><code>{{prettify(response.originalRequest.body.raw)}}</code></pre>
</div>
</div>
{% endif %}
{% endif %}
<div class="panel-body">

<pre><code>{{response.code}} {{response.status}}</code></pre>
Expand Down