Ether Framework
Unified API docs for Ether modules
Loading...
Searching...
No Matches
OpenApiDocument.java
Go to the documentation of this file.
1package dev.rafex.ether.http.openapi.model;
2
3/*-
4 * #%L
5 * ether-http-openapi
6 * %%
7 * Copyright (C) 2025 - 2026 Raúl Eduardo González Argote
8 * %%
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 * THE SOFTWARE.
26 * #L%
27 */
28
29import java.util.List;
30import java.util.Map;
31
32import dev.rafex.ether.json.JsonUtils;
33
34public record OpenApiDocument(String openapi, OpenApiInfo info, List<OpenApiServer> servers,
35 Map<String, OpenApiPathItem> paths, OpenApiComponents components) {
36
37 public OpenApiDocument {
38 servers = servers == null ? List.of() : List.copyOf(servers);
39 paths = paths == null ? Map.of() : Map.copyOf(paths);
40 }
41
42 public String toJson() {
43 return JsonUtils.toJson(this);
44 }
45
46 public String toPrettyJson() {
47 return JsonUtils.toPrettyJson(this);
48 }
49}
static String toJson(final Object value)
static String toPrettyJson(final Object value)
record OpenApiComponents(Map< String, OpenApiSchema > schemas, Map< String, OpenApiResponse > responses)
record OpenApiInfo(String title, String version, String description, String termsOfService, String license)
record OpenApiDocument(String openapi, OpenApiInfo info, List< OpenApiServer > servers, Map< String, OpenApiPathItem > paths, OpenApiComponents components)
OpenAPI document assembly support for Ether HTTP modules.