Arhn - архитектура программирования

Изменение SwaggerUI для удаления необходимого PathParam

У меня есть требование использовать необязательные параметры пути. Итак, сделайте это так, как показано ниже;

@ApiOperation(httpMethod = "GET", value = "Get User Details With Optional Path Parameters", notes = "Output depends on values provided")
@ApiResponses(value = {
        @ApiResponse(code = 404, message = "We do not unserstand what you mean"),
        @ApiResponse(code = 400, message = "You are not requesting like a BOSS.") })
@RequestMapping(value = { "/getuser/userid/{userid}",
        "/getuser",
        "/getuser/userid/{userid}/alias/{alias}", "getuser/alias/{alias}" }, method = RequestMethod.GET, produces = {
        MediaType.APPLICATION_JSON_VALUE, MediaType.APPLICATION_XML_VALUE })
@ResponseStatus(HttpStatus.OK)
private UserSchema getUserDetails(
        @PathVariable Optional<String> userid,
        @PathVariable Optional<String> alias) {
    Users user = null;
    UserSchema returningSchema = buildDefaultSchema();
    if (alias.isPresent()) {
        //Get The Value
    } else {
        //Try Get Other Value and do stuff etc.
    }
    //Similar for userid

    try {
        //Get User Data From DB
        user = dao.getUserData(userid,alias);
        //Bind data to returning schema
    } catch (Exception ex) {
        Log.error(getClass().getName(), ex);
        returningSchema.setResponseText("Something is Wrong");
    } 
    return returningSchema;
}

Но из-за чванства это не позволяет сделать запрос, поскольку PathVariables относятся к типу required. Я плохо разбираюсь в javascript. Пробовал это решение для изменения swagger-ui.js, но, похоже, потерялся в огромный файл и не может найти упомянутую часть.

Я использую последнюю версию Swagger-UI. Могу ли я сделать запрос с необязательными переменными пути, и правильный путь должен быть показан в swagger?

ПРИМЕЧАНИЕ. Я знаю, что в спецификации swagger не разрешены необязательные переменные пути. Но я хочу изменить это только в своем приложении.

Спасибо.


Ответы:


1

Да, вы определенно можете использовать форк swagger-js и swagger-ui, чтобы поддержать это. Взгляните на Operation.prototype.getMissingParams в operation.js.

15.01.2016
Новые материалы

Коллекции публикаций по глубокому обучению
Последние пару месяцев я создавал коллекции последних академических публикаций по различным подполям глубокого обучения в моем блоге https://amundtveit.com - эта публикация дает обзор 25..

Представляем: Pepita
Фреймворк JavaScript с открытым исходным кодом Я знаю, что недостатка в фреймворках JavaScript нет. Но я просто не мог остановиться. Я хотел написать что-то сам, со своими собственными..

Советы по коду Laravel #2
1-) Найти // You can specify the columns you need // in when you use the find method on a model User::find(‘id’, [‘email’,’name’]); // You can increment or decrement // a field in..

Работа с временными рядами спутниковых изображений, часть 3 (аналитика данных)
Анализ временных рядов спутниковых изображений для данных наблюдений за большой Землей (arXiv) Автор: Рольф Симоэс , Жильберто Камара , Жильберто Кейрос , Фелипе Соуза , Педро Р. Андраде ,..

3 способа решить квадратное уравнение (3-й мой любимый) -
1. Методом факторизации — 2. Используя квадратичную формулу — 3. Заполнив квадрат — Давайте поймем это, решив это простое уравнение: Мы пытаемся сделать LHS,..

Создание VR-миров с A-Frame
Виртуальная реальность (и дополненная реальность) стали главными модными терминами в образовательных технологиях. С недорогими VR-гарнитурами, такими как Google Cardboard , и использованием..

Демистификация рекурсии
КОДЕКС Демистификация рекурсии Упрощенная концепция ошеломляющей О чем весь этот шум? Рекурсия, кажется, единственная тема, от которой у каждого начинающего студента-информатика..