Web Api interface generation

[bohdan-harniuk]

Description (*)
This PR adds the generation of a Web API interface for a service.

What was done:

1. generation of a Web API interface for a service.
2. added possibility to choose one or more methods to be included in an interface
3. added possibility to choose interface name and change its description (default one is taken from the service)
4. all methods short description taken from the service methods (or default TODO, that asks to add short description)
5. implements added for a service
6. implements class imported in use block for a service
7. all included in interface methods annotations replaced with @inheritdoc annotations.
8. added test case to test simple service with primitive types
9. added test case to test simple service with Object types
10. testing for inserting @inheritdoc annotations
11. testing for an interface implemented by a service
12. testing for interface FQN added in an import (use) block

Service to add Web Api interface:

Open the context menu on it and choose Web API interface generation action:

Choose methods to include in the interface, change default name and description:

Results:

Questions or comments
To get generated Doc Annotations beautiful, go to the Preferences... > Editor > Code Style > PHP > PHPDoc > Blank lines around parameters and activate this configuration.

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with integration/functional tests (if applicable)
• All automated tests passed successfully (all builds are green)

[eduard13]

Hi @bohdan-harniuk, thank you for your contribution. Could you please rename all the visible text occurrences of Api to API, since API is an acronym and should be correctly used. Below you may see couple of places, but would be good to change it on every place that is visible to the user.

Also, can we exclude these API generators for Test/ or probably *Test.php files, in order to not overload the context menu? I don't see any use case, when we have to create an API for any kind of tests.

Thank you.

[eduard13]

Suggested change

	<internalFileTemplate name="Magento Web Api XML"/>
	<internalFileTemplate name="Web Api Interface"/>
	<internalFileTemplate name="Magento Web API XML"/>
	<internalFileTemplate name="Web API Interface"/>

[bohdan-harniuk]

Done.

[eduard13]

Suggested change

	<text value="Api For Class"/>
	<text value="API For Class"/>

[bohdan-harniuk]

Done.

[bohdan-harniuk]

Thank you, @eduard13, for the great findings! I've fixed them.

[eduard13]

Thank you for your contribution 👍