Skip to content

[Docs] Polish docs for bottom-up approach #735

@b-admike

Description

@b-admike

Story

As a LoopBack4 user, I would like an easy to follow and intuitive tutorial which shows me how to make a LB4 app using TypeScript model definitions, decorators, and API spec fragments.

We already have a tutorial repository in https://github.com/strongloop/loopback4-example-getting-started, now we need to expose it in our docs on loopback.io.

See also #729

Acceptance Criteria

  • Rename http://loopback.io/doc/en/lb4/Defining-and-validating-the-API.html to something like "Define your API top-down way"
  • Add a new page at the same level, something like "Define your API bottom-up way". Explain basic concepts (controller decorators like @post, @param etc.) and point people to example-getting-started as the tutorial.
  • Add a note to both top-down and bottom-up pages pointing readers to each other, mentioning that both approaches are valid and fully supported by LoopBack.
  • In http://loopback.io/doc/en/lb4/Examples-and-tutorials.html, update the description for example-getting-started to make it clear the example is showing bottom-up approach.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions