René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Extending/adding templates","articleBody":"**Is your feature request related to a problem? Please describe.**\r\nThe OpenAPI specs I'm generating clients from are a bit convoluted. Lots of models with few differences, resulting in a lot of models submodules and classes. To make the clients more developer-friendly, I'm wrapping all their endpoints in one class each, flattening the arguments in each method.\r\n\r\nA typical example:\r\n\r\n```python\r\nclass Datasets(_API):\r\n    \"\"\"The datasets API.\"\"\"\r\n\r\n    def create(self, solution_id: Optional[str] = None) -\u003e Dataset:\r\n        return datasets_api.create_dataset(client=self.client, json_body=DatasetCreate(solution_id=solution_id))\r\n\r\n# _API is a base class setting self.client\r\n# datasets_api is the generated datasets_client.api.default module\r\n# Dataset and DatasetCreate are generated models\r\n```\r\n\r\nAs you can see I'm simplifying the name and usage:\r\n```python\r\nfrom datasets_client import Client\r\nfrom datasets_client.api import default as datasets_api\r\nfrom datasets_client.models import DatasetCreate\r\n\r\nclient = Client(...)\r\ndatasets_api.create_dataset(client, json_body=DatasetCreate(solution_id=solution_id))\r\ndatasets_api.other_method(client, *other_nested_args_and_models)\r\n```\r\n\r\n...becomes:\r\n\r\n```python\r\nfrom datasets_client import Client, Datasets\r\n\r\ndatasets = Datasets(Client(...))\r\ndatasets.create(solution_id)  # don't pass client each time\r\ndatasets.other_method(*other_flat_args)\r\n```\r\n\r\nI can then wrap multiple classes like that into a main one:\r\n\r\n```python\r\nclass API:\r\n    def __init__(self, base_url, token):\r\n        self.base_url = base_url\r\n        self.datasets = Datasets(\r\n            client=AuthenticatedClient(base_url=self.base_url + \"/rest-of-the-url\", token=token)\r\n        )\r\n        self.other_api= OtherAPI(\r\n            client=AuthenticatedClient(base_url=self.base_url + \"/rest-of-the-other-url\", token=token)\r\n        )\r\n        ...\r\n```\r\n\r\nIn the end, a developer can just import and instantiate the API class, and start using every possible endpoint, without importing any model or endpoint themselves:\r\n\r\n```python\r\nfrom project import API\r\n\r\napi = API(\"http://example.com\", \"secret\")\r\napi.datasets.create(...)\r\napi.other_api.check_status(...)\r\n```\r\n\r\nAnyway! (just explaning my use case)\r\n\r\n**Describe the solution you'd like**\r\nI'm not asking you to change how to generate clients. Rather, I'd like to be able to \"add\" templates to the generation process, so I could automatically (re)generate these wrapper classes of mine, using `openapi-python-client`'s Jinja context. Sorry for the long introduction 😅 \r\n\r\nIt could be done with a command line option to tell `openapi-python-client` to render every template within the specified folder into the generated client. The directory structure would be respected, allowing the user to \"inject\" new contents in any subfolder of the generated client.\r\n\r\n**Describe alternatives you've considered**\r\nImprove the OpenAPI specs I'm using, but it would result in breaking changes, so a lot more work for many other people in my team and other teams 😮 \r\n\r\n**Additional context**\r\nMaybe what I'm doing here is plain wrong and I'm losing benefits of the generated clients layouts? Don't hesitate to share on this matter 😄 \r\n","author":{"url":"https://github.com/pawamoy","@type":"Person","name":"pawamoy"},"datePublished":"2020-08-28T08:56:03.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/171/openapi-python-client/issues/171"}