Remove dependency on PHP method naming about mill HOT 4 OPEN

I think there are a few options we can do:

• Add a methods attribute to the <class> element for controllers in mill.xml, that takes a comma separated list of methods.
  • Pros
    • Makes it very clear what methods of your controllers are being documented.
  • Cons
    • Config file will become incredibly large, and unwieldy with tens, to hundreds of <class> entries.
    • This would break the <directory> element for specifying a directory of controllers to scan.
• Look at all the pubic methods that exist on the controller
  • Pros
    • No configuration changes needed or required for this to work
  • Cons
    • Will make documentation validation a little trickier as right now Mill throws errors if a resource action is undocumented. So we could make it that if there is no @api-uri on the public method that it's looking at, it'll just ignore it completely. Downside to that, though, is that if you ever forget to add that annotation, that action isn't going to be in your documentation.

In any case, we'd need to add a new, required, @api-method annotation for documenting the REST method that that action is supported on. Unclear if we'd allow multiple of those on a single action.

from mill.

Another option we can do is support regex on methods annotations. So if you don't support GET, PATCH, etc. but at least have a common format for your controller methods, that might work.

<directory name="controllers/" suffix=".php" methods="^get(.+)" />
<class name="\MyApplication\Some\Controller" methods="^handle(.+)" />

It's not horrible.

from mill.

Along with the config change necessary to handle this, we'll also need to update the @api-uri annotation to support supplying an HTTP method, since that method will no longer be obtained by the class method.

Maybe:

@api-uri:visibility {Movies} GET:/movies

from mill.

The new plan is to introduce an @api-method annotation that'll solve all of these problems automatically.

from mill.