Skip to content

Commit

Permalink
docs: add small section explaining the API (#258)
Browse files Browse the repository at this point in the history
  • Loading branch information
jonaslagoni authored Mar 15, 2021
1 parent 9efaeee commit d817087
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ Head over to [asyncapi/openapi-schema-parser](https://www.github.com/asyncapi/op
Head over to [asyncapi/raml-dt-schema-parser](https://www.github.com/asyncapi/raml-dt-schema-parser) for more information.

## API documentation
The parser API is generally structured the same way as the AsyncAPI specification, with additional support functions such as `has<Something>()`. The parser uses wrapped functions to get the properties stored in JSON. This means in order to get the info object you would use the function `doc.info()` and to get the title inside the info object you call `doc.info().title()`.

See [API documentation](/API.md) for more example and full API reference information.

Expand Down

0 comments on commit d817087

Please sign in to comment.