play-api-refiner

KO | EN

gitlite — search

#python #typescript #llm #go #machine-learning #rust #linux #docker #macos #awesome #kubernetes #awesome-list #ios #openai

play-api-refiner

(★ 16)

No description available.

play-api-refiner 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build status](https://api.travis-ci.com/dgouyette/play-api-refined.svg?branch=develop)](https://travis-ci.com/dgouyette/play-api-refined?branch=develop)
[![codecov](https://codecov.io/gh/dgouyette/play-api-refined/branch/develop/graph/badge.svg)](https://codecov.io/gh/dgouyette/play-api-refined)
[![License](https://img.shields.io/:license-MIT-blue.svg)](https://opensource.org/licenses/MIT)

# Play API Refined

A tiny library to generate OpenAPI  documentation and json schema based on Refined's case classes.

## Setup

In order to use play-json-org.dgouyette.refined you need to add the following lines to your `build.sbt`:

```scala
resolvers += Resolver.bintrayRepo("dgouyette", "maven")

libraryDependencies += "org.dgouyette" %% "api-refiner" % "1.0.0-M1"
```

## Usage

### Play Json Refined  errors

To return json errors based on org.dgouyette.refined classes you must import :

````scala
import org.org.dgouyette.json.RefinedRuntimeValidator._
````

### Json Schema generation

```scala

case class CollectionStringNonEmpty(e : List[String] Refined NonEmpty)
JsonSchema.asJsValue[CollectionStringNonEmpty] // => {"e":{"minLength":1,"type":"array","items":{"type":"string"}}}

```

### Json Schema on Client Error

```scala
case class LoginDTO(email  : String Refined NonEmpty, password : String Refined NonEmpty)

@Singleton
class HomeController @Inject()(bp: BodyParserWithJsonSchema) extends AbstractController(cc) {
  implicit val loginSchema = JsonSchema.asJsValue[LoginDTO]
  implicit val dtoSchema = JsonSchema.asJsValue[SimpleDTO]
  
  def login(): Action[LoginDTO] = Action(bp.jsonRefined(LoginDTO.fmt, loginSchema)) {
    implicit request =>
    Ok
  }
}
```

With a bad client request :

`curl -X POST http://localhost:9000/login -d '{"email" :"","password" :"" }'`

You will have this error

```json
{
    "obj.email": [
        {
            "msg": [
                "Predicate isEmpty() did not fail."
            ],
            "args": []
        }
    ],
    "_schema": {
        "password": {
            "minLength": 1,
            "type": "string"
        },
        "email": {
            "minLength": 1,
            "type": "string"
        }
    },
    "obj.password": [
        {
            "msg": [
                "Predicate isEmpty() did not fail."
            ],
            "args": []
        }
    ]
}
```

## Generate OpenAPI (Swagger) Documentation

OpenAPIController : 
````scala
def json: Action[Unit] = Action(parse.empty) {
    implicit  req =>
     Ok(OpenAPI.fromRoutesFile("conf/routes"))
  }
````

conf/routes
```
POST        /login                           controllers.HomeController.login
GET         /doc/json                        controllers.OpenAPIController.json
```

![OpenAPI Documentation](https://raw.githubusercontent.com/dgouyette/play-api-refiner/develop/openAPI.png)

play-api-refiner

play-api-refiner 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

play-api-refiner

play-api-refiner 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README