RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-15 05:53:14 +03:00
Code Issues Projects Releases Wiki Activity

Fix tests, fix markdown/html requirements output

Browse Source
This commit is contained in:
William DURAND 2012-07-20 02:02:45 +02:00
parent cca97cf6af
commit a8e0b24b95
3 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Formatter/MarkdownFormatter.php
View File

@ -46,6 +46,7 @@ class MarkdownFormatter extends AbstractFormatter
if (!empty($infos['type'])) { if (!empty($infos['type'])) {
$markdown .= sprintf(" - Type: %s\n", $infos['type']); $markdown .= sprintf(" - Type: %s\n", $infos['type']);
} }
if (!empty($infos['description'])) { if (!empty($infos['description'])) {
$markdown .= sprintf(" - Description: %s\n", $infos['description']); $markdown .= sprintf(" - Description: %s\n", $infos['description']);
} }
@ -61,7 +62,7 @@ class MarkdownFormatter extends AbstractFormatter
$markdown .= sprintf("%s:\n\n", $name); $markdown .= sprintf("%s:\n\n", $name);
foreach ($filter as $key => $value) { foreach ($filter as $key => $value) {
$markdown .= sprintf(" * %s: %s\n", $key, trim(json_encode($value), '"')); $markdown .= sprintf(" * %s: %s\n", ucwords($key), trim(str_replace('\\\\', '\\', json_encode($value)), '"'));
} }
$markdown .= "\n"; $markdown .= "\n";

2
Resources/views/method.html.twig
View File

@ -72,7 +72,7 @@
{% for key, value in infos %} {% for key, value in infos %}
<tr> <tr>
<td>{{ key|title }}</td> <td>{{ key|title }}</td>
<td>{{ value|json_encode|trim('"') }}</td> <td>{{ value|json_encode|replace({'\\\\': '\\'})|trim('"') }}</td>
</tr> </tr>
{% endfor %} {% endfor %}
</table> </table>

22
Tests/Formatter/MarkdownFormatterTest.php
View File

@ -34,12 +34,12 @@ _index action_
a: a:
* dataType: integer * DataType: integer
b: b:
* dataType: string * DataType: string
* arbitrary: ["arg1","arg2"] * Arbitrary: ["arg1","arg2"]
### `GET` /tests ### ### `GET` /tests ###
@ -50,12 +50,12 @@ _index action_
a: a:
* dataType: integer * DataType: integer
b: b:
* dataType: string * DataType: string
* arbitrary: ["arg1","arg2"] * Arbitrary: ["arg1","arg2"]
### `POST` /tests ### ### `POST` /tests ###
@ -167,8 +167,8 @@ _This method is useful to test if the getDocComment works._
page: page:
* requirement: \d+ * Requirement: \d+
* description: Page of the overview. * Description: Page of the overview.
MARKDOWN; MARKDOWN;
$this->assertEquals($expected, $result); $this->assertEquals($expected, $result);
@ -191,12 +191,12 @@ _index action_
a: a:
* dataType: integer * DataType: integer
b: b:
* dataType: string * DataType: string
* arbitrary: ["arg1","arg2"] * Arbitrary: ["arg1","arg2"]
MARKDOWN; MARKDOWN;