使用flask restplus 进行api 记录的特定时间格式 [英] specific time format for api documenting using flask restplus

问题描述

我有一个 api，它接受请求正文中的 start_time、end_time 和一个布尔值 closed_all_day.

I have an api which accepts start_time, end_time and a boolean closed_all_day in body of the request.

from flask_restplus import Namespace, fields

timings = api.model('open times', {
     'start_time': fields.String(required=True, description='Time in 24 hour HH:MM format, defaulted to 00:00 if closed_all_day'),
     'end_time': fields.String(required=True, description='Time in 24 hour HH:MM format, defaulted to 00:00 if closed_all_day'),
     'closed_all_day': fields.Boolean(required=True, description='If True overwrites start_time and end_time')
})

start_time 和 end_time 的格式为 HH:MM(24 小时格式)

The format of start_time and end_time would be in HH:MM (24 hour format)

如果我使用

fields.Date

或

fields.DateTime

然后我得到了完整的 ISO 日期格式，这也不是我想要的.

then I got the full ISO date format, which is also not what I want.

有没有办法限制输入为 HH:MM 格式?

Is there a way to restrict the input to HH:MM format ?

推荐答案

这样做的方法是:

from datetime import time


class TimeFormat(fields.Raw):
    def format(self, value):
        return time.strftime(value, "%H:%M")

timings = Model('timings', {
    'start_time': TimeFormat(readonly=True, description='Time in HH:MM', default='HH:MM'),
    'end_time': TimeFormat(readonly=True, description='Time in HH:MM', default='HH:MM'),
    'closed_all_day': fields.Boolean(readOnly=True, description='True or False', default=False)
})

这篇关于使用flask restplus 进行api 记录的特定时间格式的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！