Skip to content

Commit 4269293

Browse files
committed
readme, one more time
1 parent 6ed7510 commit 4269293

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -316,15 +316,13 @@ One can configure Ring-Swagger by providing options to `api-middleware` for key
316316

317317
### Api Validation
318318

319-
To ensure that your API is valid, one can call `compojure.api.swagger/validate. It takes the api (the ring handler returned by `api` or `defapi`) as an parameter and returns the api of throws an Exception. The validation does the following:
319+
To ensure that your API is valid, one can call `compojure.api.swagger/validate`. It takes the api (the ring handler returned by `api` or `defapi`) as an parameter and returns the api of throws an Exception. The validation does the following:
320320

321321
1. if the api is not an swagger api (does not the `swagger-docs` mounted) and compiles, it's valid
322322
2. if the api is an swagger api (does have the `swagger-docs` mounted):
323323
- Ring Swagger is called to verify that all Schemas can be transformed to Swagger JSON Schemas
324324
- the swagger-spec endpoint is called with 200 responses status
325325

326-
**TODO**: optionally [validate](https://github.com/metosin/compojure-api/wiki/Validating-the-Swagger-SPEC) the swagger spec itself againt the JSON Schema.
327-
328326
```clojure
329327
(require '[compojure.api.sweet :refer :all])
330328
(require '[compojure.api.swagger :refer [validate])
@@ -344,6 +342,8 @@ To ensure that your API is valid, one can call `compojure.api.swagger/validate.
344342

345343
```
346344

345+
**TODO**: optionally [validate](https://github.com/metosin/compojure-api/wiki/Validating-the-Swagger-SPEC) the swagger spec itself againt the JSON Schema.
346+
347347
### Bi-directional routing
348348

349349
Inspired by the awesome [bidi](https://github.com/juxt/bidi), Compojure-api also supports bi-directional routing. Routes can be attached with a

0 commit comments

Comments
 (0)