Документ HAL «_links» от Spring Hateoas (с чванством)? [закрыто]
У меня есть служба REST, которую я хочу документировать для моей команды разработчиков.
Поэтому я добавил несколькоLinks
отSpring-Hateoas
к моим ресурсам API, и подключен к немуswagger-springmvc
@Api...
аннотации, чтобы документировать все и сделать хорошую справку по API для моей команды Angular, чтобы иметь возможность понять мой сервис REST.
Проблема в том, чтоswagger
не может обнаружить, какие ссылки возможны, и просто дать мне большой массивLinks
не говоря об их возможных ценностях.
Вот (простой) пример. Swagger обнаруживает:
Model Schema
CollectionListResource {
collections (array[CollectionResource]): All available collections,
links (array[Link]): Relations for next actions
}
CollectionResource {
collectionId (string): Collection Unique Id,
name (string): Human readable collection name,
links (array[Link]): Relations for next actions
}
Link {
rel (string, optional),
templated (boolean, optional),
href (string, optional)
}
И я получаю на самом деле в HAL:
{"collections":
[{"collectionId":"5370a206b399c65f05a7c59e",
"name":"default",
"_links":{ [
"self":{
"href":"http://localhost:9080/collections/5370a206b399c65f05a7c59e"
},
"delete":{
"href":"http://localhost:9080/collections/5370a206b399c65f05a7c59e"
}
]}
}, ...]}
Я пытался продлитьLink
а такжеResourceSupport
чтобы аннотировать их версию, но это привело меня в никуда.
Есть ли способ / инструмент, который я мог бы использовать для создания хорошего документа API, сообщающего, чтоself
отношение, чтобы получить содержание, иdelete
Отношение это удалить коллекцию?
Мне понравился Swagger за его хороший пользовательский интерфейс, но я не против поменять инструмент документации, если это поможет с документомдействительно полный.
В конце концов, я мог бы подумать о смене пружинных колокольчиков на другой генератор ссылок, но я не уверен, что сейчас есть лучший инструмент.