Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create 2022-05-18-faststore.md #1305

Merged
merged 6 commits into from
May 18, 2022
Merged

Create 2022-05-18-faststore.md #1305

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6242524
Create 2022-05-18-faststore.md
PedroAntunesCosta May 17, 2022
4ae854f
Correcting release note
PedroAntunesCosta May 18, 2022
cf29d35
Update 2022-05-18-faststore.md
PedroAntunesCosta May 18, 2022
f22b74a
Update 2022-05-18-faststore.md
PedroAntunesCosta May 18, 2022
c529326
Updating `releases` file and release note title
PedroAntunesCosta May 18, 2022
f6b3455
Update 2022-05-18-faststore.md
PedroAntunesCosta May 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/blog/2022-05-18-faststore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
description: The FastStore API types, queries and mutations have been documented. You can check it now by using GraphiQL.
tags: [faststore]
hide_table_of_contents: false
---

# FastStore API documentation updated

We have made available FastStore API reference documentation. You can check it now by using [GraphiQL](https://github.com/graphql/graphiql).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
We have made available FastStore API reference documentation. You can check it now by using [GraphiQL](https://github.com/graphql/graphiql).
FastStore API reference documentation is now available. You can check it via the [GraphiQL](https://github.com/graphql/graphiql) IDE.


## What has changed?

When working on a FastStore project, you can run it locally and use **GraphiQL** to explore the API. Now, when you do this you will see that each type, argument, querie and mutation has an associated description.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When working on a FastStore project, you can run it locally and use **GraphiQL** to explore the API. Now, when you do this you will see that each type, argument, querie and mutation has an associated description.
While working on your FastStore website, you can run your project locally and explore the API using **GraphiQL**. Now, when you do this, you will see that each type, argument, query, and mutation has an associated description.


## What needs to be done?

To see these new docs follow these steps:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To see these new docs follow these steps:
To explore the FastStore API documentation, follow these steps:

1. Run `yarn` in your project to reinstall the `@faststore/api` dependency.
2. Run `yarn develop` to start a local server.
3. Access GraphiQL by going to this address:
```
http://localhost:8000/__graphql
```
4. Click on the `Docs` button on the upper right corner.
5. On the docs tab you can browse through the definitions or search for types by name.

![Screen capture of the procedure described above.](https://vtexhelp.vtexassets.com/assets/docs/src/viewing%20docs%20in%20graphiql%2018052022___8e00bfb24dcfc4c7cddcd45bc0863c8a.gif)