danielgtaylor / danielgtaylor/aglio

Trailing slahes in endpoint URIs are discarded

Open
#209 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
CoffeeScript
Stars
4.7k
Forks
471
PR merge metrics
No merged PRs in 30d

Description

I want to document an existing API with API Blueprint and generate static HTML using aglio. The API uses trailing slashes on all endpoints, but aglio removes them in the generated documentation.
I don't mean to start a discussion whether trailing slashes are a good idea, I just think the API doc-tool shouldn't be opinionated in this regard and just output exacly what I'm telling it ;-)

Example input:

```
FORMAT: 1A
HOST: http://www.example.com/api

# Example API

## Example Resource [/example/]

### GET

+ Response 200 (application/json)
```

Generated output:
![screen shot 2016-01-05 at 10 21 34](https://cloud.githubusercontent.com/assets/1180845/12111533/5e9780c6-b396-11e5-9fa6-ae34793fb9da.png)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.