Skip to content

Commit

Permalink
Update openapi.md (#2105)
Browse files Browse the repository at this point in the history
Co-authored-by: Adam Warski <adam@warski.org>
  • Loading branch information
minnieshi and adamw committed Mar 13, 2024
1 parent f5c6b55 commit a6330cc
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions docs/openapi.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
# OpenAPI

sttp-client [request definitions](requests/basics.md) can be automatically generated from [openapi](https://swagger.io/specification/) `.yaml` specifications using:

1. the [sttp-openapi-generator](https://github.com/ghostbuster91/sttp-openapi-generator)
2. the `scala-sttp` code generator, included in the [openapi-generator](https://github.com/OpenAPITools/openapi-generator) project

## Using sttp-openapi-generator

See the project's [docs](https://github.com/ghostbuster91/sttp-openapi-generator).
sttp-client [request definitions](requests/basics.md) can be automatically generated from [openapi](https://swagger.io/specification/) `.yaml` specifications using
the `scala-sttp` code generator, included in the [openapi-generator](https://github.com/OpenAPITools/openapi-generator) project.

## Using the openapi-generator

Expand All @@ -30,6 +24,10 @@ openapi-generator-cli generate \
-o samples/client/petstore/
```

### Maven managed

For maven project use plugin [openapi-generator-maven-plugin](https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator-maven-plugin)

### Sbt managed

In this setup openapi-generator is plugged into sbt project through the [sbt-openapi-generator](https://github.com/OpenAPITools/sbt-openapi-generator/) plugin.
Expand Down

0 comments on commit a6330cc

Please sign in to comment.