Skip to content

Commit

Permalink
docs(readme): add samples
Browse files Browse the repository at this point in the history
  • Loading branch information
anymaniax committed Apr 30, 2020
1 parent ddb7358 commit d5dba6b
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@
<img src="/logo/orval-logo-horizontal.png?raw=true" width="500" height="160" alt="Orval - Restfull Client Generator" />
</p>
<h3 align="center">
Inspired by [restful-react](https://github.com/contiamo/restful-react)
Inspired by <a href="https://github.com/contiamo/restful-react">restful-react</a>
</h3>

## Summary

- [Code Generation](#code-generation)
- [Usage](#usage)
- [Samples](#samples)
- [Validation of the OpenAPI specification](#validation-of-the-openapi-specification)
- [Import from GitHub](#import-from-github)
- [Transforming an Original Spec](#transforming-an-original-spec)
Expand Down Expand Up @@ -50,6 +51,12 @@ Your client can then be generated by running `npm run generate-fetcher`. Optiona
}
```

### Samples

You can find below some samples on codesandbox

- [react app](https://codesandbox.io/s/orval-sample-react-app-2ytyx)

#### Validation of the OpenAPI specification

To enforce the best quality as possible of specification, we have integrated the amazing [OpenAPI linter from IBM](https://github.com/IBM/openapi-validator). We strongly encourage you to setup your custom rules with a `.validaterc` file, you can find all useful information about this configuration [here](https://github.com/IBM/openapi-validator/#configuration).
Expand Down

0 comments on commit d5dba6b

Please sign in to comment.