Open VincentTam opened 3 years ago
We need to promote the dev branch of staticman to master. In dev I introduced some autogenerated swagger docs for the api. See the annotations here on each of the routes.
https://github.com/eduardoboucas/staticman/blob/dev/source/server.js
Made a PR here to address this.
Description
In step 4 of the quick start guide https://github.com/eduardoboucas/staticman.net/blob/d1174fed6813a79f5ab002e01b3a77cfa47cea60/docs/getting-started.md#step-4-hook-up-your-forms, it's said that the API are documented at that route.
However, I tried to GET
https://myinstance.herokuapp.com/v3/api-docs
(withmyinstance
replaced with my instance) and got a 404 error.I'm not disclosing info about my browser because this not a client-side problem. Here's a related Heroku log entry. Observe that the
path="/api-docs"
andstatus=404
. (I hide thehost
andfwd
here.)Analysis
Searching the code with "api-docs" in the official repo gives nothing: https://github.com/eduardoboucas/staticman/search?q=api-docs&type=code.