In this tutorial, we’ll see how to declare dates in an OpenAPI file, in this case, implemented with Swagger<\/a>. This will allow us to manage input and output dates in a standardized way when calling external APIs.<\/p>\n Swagger is a set of tools implementing the OpenAPI Specification<\/strong><\/a> (OAS),\u00a0 a language-agnostic interface to document RESTful APIs. This allows us to understand the capabilities of any service without accessing the source code.<\/p>\n To implement this,\u00a0 we’ll have a file in our project, typically YAML or\u00a0JSON,<\/em>\u00a0describing APIs using OAS. We’ll then use Swagger tools to:<\/p>\n The OpenAPI file example<\/a>\u00a0contains different sections, but we’ll focus on the model definition.<\/p>\n Let’s define a User<\/em> entity using the OAS:<\/p>\n To define a date, we use an object with:<\/p>\n In this case, we used the\u00a0date format<\/em> to describe the createdAt<\/em> date. This format describes dates using the ISO 8601 full-date<\/em><\/a> format.<\/p>\n Additionally, if we also want to specify the time, we’ll use date-time <\/em>as the format.<\/em> Let’s see an example:<\/p>\n In this case, we’re describing date-times using the ISO 8601 full-<\/em>time<\/i><\/a>\u00a0format.<\/p>\n Using OAS, we can describe dates with other formats as well. To do so, let’s use the pattern<\/em> field:<\/p>\n Clearly, this is the less readable method, but the most powerful. Indeed, we can use any regular expression in this field.<\/p>\n In this article, we’ve seen how to declare dates using OpenAPI. We can use standard formats offered by OpenAPI as well as custom patterns to match our needs. As always, the source code of the example we used is available\u00a0over on GitHub<\/a>.<\/p>\n The post Dates in OpenAPI Files<\/a> first appeared on Baeldung<\/a>.<\/p>\n Let’s see how to declare dates in an OpenAPI file, in this case, implemented with Swagger.<\/p>\n The post Dates in OpenAPI Files<\/a> first appeared on Baeldung<\/a>.<\/p>\n2. Swagger vs. OAS<\/h2>\n
\n
3. Defining a Date<\/h2>\n
components:\r\n User:\r\n type: \"object\"\r\n properties:\r\n id:\r\n type: integer\r\n format: int64\r\n createdAt:\r\n type: string\r\n format: date\r\n description: Creation date\r\n example: \"2021-01-30\"\r\n username:\r\n type: string<\/code><\/pre>\n\n
4. Defining a Date-Time<\/h2>\n
createdAt:\r\n type: string\r\n format: date-time\r\n description: Creation date and time\r\n example: \"2021-01-30T08:30:00Z\"<\/code><\/pre>\n5. The pattern field<\/em><\/h2>\n
customDate: \r\n type: string \r\n pattern: '^\\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$'\r\n description: Custom date \r\n example: \"20210130\"<\/code><\/pre>\n6. Conclusion<\/h2>\n
<\/p>\n
![](\"https:\/\/assets.feedblitz.com\/i\/fblike20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/googleplus20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/pinterest20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/twitter20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/email20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/rss20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/comments20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/commentsrss20.png\")
<\/a> <\/div>\n\n![\\\"IT\u96fb\u8166\u88dc\u7fd2](\\\"http:\/\/itteacheritfreelance.hk\/test\/wordpress\/wp-content\/uploads\/2016\/05\/logo2-2.png\\\"){kind=logo}
\r\nwww.itsec.hk<\/a>
\r\nwww.itsec.vip<\/a>
\r\nwww.itseceu.uk<\/a>
<\/p>","protected":false},"excerpt":{"rendered":"<\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/div>\n<\/div>","protected":false},"author":214,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"slim_seo":{"title":"Dates in OpenAPI Files - ITTeacherITFreelance.hk","description":"Let's see how to declare dates in an OpenAPI file, in this case, implemented with Swagger. The post Dates in OpenAPI Files first appeared on Baeldung . &"},"footnotes":""},"categories":[6],"tags":[],"_links":{"self":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts\/68694"}],"collection":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/users\/214"}],"replies":[{"embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/comments?post=68694"}],"version-history":[{"count":7,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts\/68694\/revisions"}],"predecessor-version":[{"id":73805,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts\/68694\/revisions\/73805"}],"wp:attachment":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/media?parent=68694"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/categories?post=68694"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/tags?post=68694"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}