https://github.com/rapidapi/paw-gql-markdown
https://github.com/rapidapi/paw-gql-markdown
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rapidapi/paw-gql-markdown
- Owner: RapidAPI
- Created: 2022-03-02T00:08:45.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-27T15:37:43.000Z (almost 3 years ago)
- Last Synced: 2025-02-22T18:50:03.225Z (12 months ago)
- Language: TypeScript
- Size: 145 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GraphQL Markdown Doc Generator
### Installation
- Download the latest release [here](https://github.com/luckymarmot/graphqldocs/releases).
- 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](https://user-images.githubusercontent.com/962502/156818898-b12b4035-0543-4bbd-b7a2-76a538d8d377.png)
- [See how to Export multiple Request](https://user-images.githubusercontent.com/962502/156818991-fd2eb1d4-0865-4df8-9493-d9645c938cc2.png)
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:
```markdown
### Request 101
This comment tag below will render the request's headers.
This comment tag below will render the request's body
By appending `:collapsed` to the tag will wrap the code block with ` ... ` markup tag
which makes it collapsible when rendered in Github Markdown.
```
Here's a list of available comment tags:
```html
Request Headers
or
Request URLParams
or
Request Body
or
Response Headers
or
Response Body
or
```