Generate JSON Schema based on JSR-303 bean validation annotations [DATAREST-735]

Augusto David Altman Quaranta opened DATAREST-735 and commented

It would be great if the JSON Schema generated when hitting the profile api (alps) is generated taking in consideration the bean validation annotations on the entities.

For example, given the following entity

@Entity
@Table(name = "clients")
public class Client {
    @Max(100)
    @Min(0)
    @NotNull
    private int percentaje;

    @NotEmpty
    private String fantasyName;

    Client() { // jpa only
    }

    public int getPercentaje() {
        return percentaje;
    }
    
    public void setPercentaje(int percentaje) {
        this.percentaje = percentaje;
    }

    public String getFantasyName() {
        return fantasyName;
    }
    
    public void setFantasyName(String fantasyName) {
        this.fantasyName = fantasyName;
    }
}

I would like to get the following JSON Schema

{
	"title": "Clients",
	"type": "object",
	"properties": {
		"fantasyName": {
			"type": "string"
		},
		"percentaje": {
			"description": "Age in years",
			"type": "integer",
			"minimum": 0,
                        "maximum": 100,
		}
	},
	"required": ["fantasyName", "percentaje"]
}

Affects: 2.4.1 (Gosling SR1)

Issue Links:

• DATAREST-736 Generate JSON Schema based on JSR-303 bean validation annotations
  ("is duplicated by")

3 votes, 7 watchers