Hybris swagger UI日期时间示例格式

时间:2018-06-25 09:06:55

标签: spring swagger swagger-ui hybris springfox

我有一个与Hybris合作的项目,我们正在通过swagger + swagger-ui提供一个宁静的API。我们对日期时间属性和参数的格式有疑问。该格式显示为:“ 2018-06-22T08:00:19.130Z”。

但是,我们在swagger-ui所提供的示例中使用并需要显示的格式为“ 2018-06-22T08:00:19Z”。

这些参数是DTO在春季之前自动生成的。

关于如何更改示例的日期时间格式的任何想法吗?

谢谢, 克里斯

1 个答案:

答案 0 :(得分:1)

这很大程度上取决于您拥有的swagger-ui版本,示例并不总是受支持,因此下面的示例假定您使用的是最新,最强大的(如果不考虑升级,则应考虑)

如果需要在查询参数中显示它,则需要将值设置为默认值:

      "parameters": [
      {
        "name": "data.d1",
        "in": "query",
        "required": false,
        "type": "string",
        "format": "date-time",
        "default": "2018-06-22T08:00:19Z",
      }

对于定义来说,只是example

"definitions": {
 "Data": {
  "properties": {
    "date0": {
      "example": "2018-06-22T08:00:19Z",
      "type": "string",
      "format": "date-time"
    }

这是这样的样子

enter image description here 这是实时版本的链接:
http://petstore.swagger.io/?url=https://raw.githack.com/heldersepu/hs-scripts/master/swagger/swagger_51019812.json#/ApiExplorer/ApiExplorer_Get