Customizing OpenAPI Especificación

DPSv2 proporciona un genérico OpenAPI especificación. Esto significa que los usuarios deben confiar en los Esquemas API para explorar esquemas, ejemplos de carga útil y otros detalles. Desde la perspectiva del usuario, este proceso puede ser tedioso y, lo que es más importante, no es amigable para el usuario.

Para abordar esto, DPSv2 ofrece un customized API disponible en /v3/api-docs o a través de la Swagger UI (generalmente disponible en /webjars/swagger-ui/index.html). El customized la versión modifica la interfaz de usuario de manera que cada genérico API(i.e., una API con un settingType el parámetro) se reescribe para proporcionar un específico API para cada tipo de configuración.

Por ejemplo, imagine que hay un tipo de configuración llamado ibanplus. El genérico API POST /settings-objects/{settingType} sería reescrito como POST /settings-objects/ibanplus. Además, todas las operaciones relacionadas se agruparían bajo el tipo de configuración específico.

El objetivo de la biblioteca DPSv2 es customize la interfaz de usuario y los esquemas tanto como sea posible, asegurando que el usuario final requiera un esfuerzo mínimo. Sin embargo, si se requieren ajustes adicionales a la OpenAPI se necesitan especificaciones, es posible que customize lo programáticamente:

SettingDefinition.<TestSetting>builder()
    .settingDefinitionOpenAPISpecCustomizer((settingDefinition, openAPI) -> {
        // Customize OpenAPI spec for this setting
    })
    .build();