GraphQL Markdown Doc Generator

Installation

• Download the latest release here.
• Go to Paw > Preferences or simply use the keyboard shortcut: cmd + ,
• Click on the Extensions tab > Open Directory, extract the content of the zip file in that directory.
• You should see GraphQLDocs Generator listed.
• Create a new Request, and on the Generators dropdown, select GraphQLDocs

Usage

• See how to Export single Request
• See how to Export multiple Request

By default, GraphQLDocs will generate a markdown document based on the Request information available. Basic Response information will only be available if there's at least one Http Exchange. It will always render the latest exchange.

You may also customize the documentation output by using the comment tags on the description textarea like so:

### Request 101

This comment tag below will render the request's headers.

<!-- request:headers -->

This comment tag below will render the request's body

<!-- request:body -->

By appending `:collapsed` to the tag will wrap the code block with `<details> ... </details>` markup tag
which makes it collapsible when rendered in Github Markdown.

Here's a list of available comment tags:

Request Headers
<!-- request:headers -->
or
<!-- request:headers:collapsed -->

Request URLParams
<!-- request:urlparams -->
or
<!-- request:urlparams:collapsed -->

Request Body
<!-- request:body -->
or
<!-- request:body:collapsed -->

Response Headers
<!-- response:headers -->
or
<!-- response:headers:collapsed -->

Response Body
<!-- response:body -->
or
<!-- response:body:collapsed -->