You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
API Extractor offers additional benefits beyond API docs generation, e.g. support for Alpha/Beta graduation and ability to remove internal classes/members from the generated .d.ts files.
Acceptance criteria
Use api-extractor to parse TypeScript sources and produce JSON files describing the API
Convert *.api.json files into format we can consume by http://apidocs.loopback.io. We should research different alternatives, for example using api-documenter to build Markdown files or writing our own converter that can produce HTML files.
Propose the new apidocs pipeline: what steps to run at publish time, what artifacts to bundle in the npm packages, what steps will be run by our apidocs site.
List of user stories/tasks needed to switch loopback-next from strong-docs to api-extractor.
I like its API review features like catching the API contracts change and checking the type export. Let's try it +1.
In case we want to try an alternative: I found a similar API generator tool typedoc, given a rough comparison typedoc has plugins for setting up pipelines and rendering markdown API documents.
Can we replace our home-grown apidocs solution based on strong-docs with https://api-extractor.com?
API Extractor offers additional benefits beyond API docs generation, e.g. support for Alpha/Beta graduation and ability to remove internal classes/members from the generated
.d.ts
files.Acceptance criteria
*.api.json
files into format we can consume by http://apidocs.loopback.io. We should research different alternatives, for example using api-documenter to build Markdown files or writing our own converter that can produce HTML files.Related PRs: #2834 and #3055
The text was updated successfully, but these errors were encountered: