How specify parameter's format in Nelmio ApiDocBundle

Question

I use input property of @ApiDoc annotation for specifieng of parameters of my api that are form's fields.

 * @ApiDoc(
 *      section="User",
 *      resource=true,
 *      input={
 *          "class"="Nik\UserBundle\Form\UserType",
 *      },
 *     ....

data_class of form is a entity that have constraint validation for properties.

I expect that nelmio api doc specify parameter format as validation constraints of entity, but format are empty.

How can i specify parameter formats in nelmio ApiDocBundle?

EDIT: maybe i write a bad question.

we can specify parsers for input & output, if we no specify parser for these, it call all parser for input & output, then all parser are called for UserType.

nelmio have a parser named ValidationParser that have a method named parseConstraint that set format for input & output, but this method is not called for my document, why?

How did you specify **description** per each field? I cannot find any reliable. — Serhii Popov, Dec 29 '20 at 16:47
Ok, I've found the answer here https://stackoverflow.com/a/43810982/1335142 — Serhii Popov, Jan 13 '21 at 13:40

score 6 · Answer 1 · edited Feb 13 '19 at 13:19

Format column is designed only for datetime, date and choice types.

For datetime and date it represents the date format like Y-m-d H:i:s and the array of choices for choice.

I haven't found any documentation about it, so I had to look through the source code. This is FormTypeParser class, the place where FormType is actually parsed and and you can see how format field is set.

In FormTypeParserTest class you can see how to use it. Just pass the string parameter with format name for one of the available types and the parser will handle it.

UPDATE: You are to define your constrains inside your FormType class.

For example:

class TestType extends AbstractType
{
    /**
     * @Assert\Type("string")
     * @Assert\Length(min="10", max="255")
     * @Assert\Regex("/^[^<>]+$/i")
     */
    private $title;

    /**
     * @Assert\Type("string")
     * @Assert\Length(min="10", max="255")
     * @Assert\Regex("/^[^<>]+$/i")
     */
    private $content;

    /**
     * @Assert\Date()
     */
    private $created;

    public function getName()
    {
        return 'test';
    }
}

will be parsed into:

ValidationParser in doParse() method finds all constrains defined in your FormType class and then executes parseConstraint() method for each of them.

You can also use FormTypeParser as I described above. For example:

public function buildForm(FormBuilderInterface $builder, array $options)
{
    $builder->add('created', 'date', array('label' => 'Created', 'format' => 'yyyy-MM-dd'))
        ->add('color', 'choice', array('label' => 'Color', 'choices' => array('grey' => '#CCCCCC', 'red' => '#FF0000')))
        ->add('save', 'submit');
}

will be parsed as:

Hope it helps now!

thank you, it's works, but in first way, i force redefine all entity properties in form type is not usefull and in second way, i can not specify format for other fields as text — ghanbari, Oct 29 '15 at 15:30

score 2 · Accepted Answer · answered Feb 24 '16 at 12:38

2

i submit a pull request that use validation metadata for format property.

you can see this PR here

answered Feb 24 '16 at 12:38

ghanbari

1,630
1
16
31

score 0 · Answer 3 · answered Oct 26 '15 at 09:50

As you can see here you can specify filter in annotation like it done documentation example.

Here part of this example:

/**
 * This is the documentation description of your method, it will appear
 * on a specific pane. It will read all the text until the first
 * annotation.
 *
 * @ApiDoc(
 *  resource=true,
 *  description="This is a description of your API method",
 *  filters={
 *      {"name"="a-filter", "dataType"="integer"},
 *      {"name"="another-filter", "dataType"="string", "pattern"="(foo|bar) ASC|DESC"}
 *  }
 * )
 */
public function getAction()
{
}

i no want write filters by hand, i will use my form as input and nelmio read form & entity validations and use those as format for parameters — ghanbari, Oct 26 '15 at 13:35

How specify parameter's format in Nelmio ApiDocBundle

3 Answers3