Skip to content

Commit

Permalink
Updated README.md with OpenAPIService details.
Browse files Browse the repository at this point in the history
  • Loading branch information
noboomu committed Oct 22, 2018
1 parent ec1e922 commit ab561e6
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,44 @@ Proteus comes with two standard services that extend the ```io.sinistral.proteus
}
```

- __OpenAPIService__

The OpenAPIService generates an openapi-spec file from your endpoints and serves the spec.

The service is configured in your ```application.conf``` file.

The default configuration:
```
openapi {

resourcePrefix="io/sinistral/proteus/server/tools/oas"

basePath= ${application.path}"/oas"

port = ${application.ports.http}

specFilename="openapi.yaml"

openapi="3.0.1"

# openapi info
securitySchemes {
ApiKeyAuth = {
type="apiKey"
in="header"
name="X-API-KEY"
}
}

servers = [
{
url=${application.path}
description="Default Server"
}
]
}
```

Under the Hood
---------------

Expand Down

0 comments on commit ab561e6

Please sign in to comment.