Refactor Docs - Githubissues

jeremybradbury / express4-https-bearer-token-mysql-api

Express 4.x HTTPS API app using Passport Bearer tokens with a MySQL backend.

https://jeremybradbury.github.io/express4-https-bearer-token-mysql-api/

The Unlicense

1 stars 0 forks source link

Refactor Docs #12

Open jeremybradbury opened 7 years ago

jeremybradbury commented 7 years ago

The docs need to moved and rewritten a bit. This should probably wait until we get a bit other features completed like: #13

Rather than /docs/* We should have:

/api/docs/* (token auth, get details about API endpoints)
/pass/docs/* (user auth, get details about token generation)
/pub/docs/* (no auth, get details about account creation and password reset)

jeremybradbury commented 7 years ago

Thinking that this should scope creep a bit as alluded to above. We finished auto models and with table property caching can also provide auto documentation!