Skip to content

api quickstart #26

Description

@amol-

currently the quickstart creates a website, it would be helpful to have a quickstart-api command that creates an api server showing all best practices on TG on how to implement JSON based APIs, both Rest and non rest.

The quickstart should have a demo part which is based on:

  • /api/movies REST controller
  • /api/demo/admin direct API that is restricted to users with manage permissions
  • /api/openapi.json which generates automatically the docs from validators of all APIController subcontrollers
  • /api/docs to use https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js to show the docs for the openapi.json
  • Authentication support via both standard TG method (cookies) and an API Token (via custom AuthMetadata.authenticate that checks a user api token instead of username/password)
  • An /index html page with the link to the /api/docs page, the list of users and their auth token to try the apis and the code block to cleanup the demo parts (delete /api/movies, /api/demo and the custom models for the movies).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions