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

Jump to bottom

Update openapi.md #2105

Merged
merged 2 commits into from
Mar 13, 2024
Merged

Update openapi.md #2105

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ace524
Update openapi.md
minnieshi Mar 13, 2024
c3bd1f3
Update openapi.md
adamw Mar 13, 2024
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
14 changes: 6 additions & 8 deletions docs/openapi.md
View file
Open in desktop
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
Loading