@theniledev/server
TypeScript icon, indicating that this package has built-in type declarations

1.0.0-alpha.194 • Public • Published

@theniledev/server

Consolidates the API and DB for working with Nile.

Adding an endpoint:

Add the openapi spec

  1. Find or add to src the name of the base property eg src/tenants
  2. Add a new folder with new method eg src/tenants/createTenantUser
  3. Add an openapi/paths folder under the method folder and insert a JSON openapi spec. This helps with conversion
  4. If there are common schemas or responses, add them to src/openapi and reference them accordingly
  5. Update /openapi/index.json with any modifications, including the file you added/changed
  6. yarn build to be sure it works.

Add new function to the sdk

  1. Add the method (using the method name) and a function for obtaining URL to the base index file with types egsrc/tenants/index (this should be a lot of copy paste)
  2. Add a test under the method folder to be sure it goes to the correct url.

Readme

Keywords

none

Package Sidebar

Install

npm i @theniledev/server

Weekly Downloads

0

Version

1.0.0-alpha.194

License

MIT

Unpacked Size

282 kB

Total Files

23

Last publish

Collaborators

  • theniledev