flask-restx | Fully featured framework for fast , easy and documented API | REST library

Recently found out about an HTTP concept called conditional requests. It is similar in idea to the first approach I had in mind, only that it's even better. The headers are standard ones and the error handling is taken care of.

Instead of using @ns.param('param_1', 'param1'), you can use @ns.expect(parser) or @ns.expect(parser, validate=True) for enabling payload validation and give choices in parser.add_argument

In accordance with waynetech's comment above, the following worked for me:

You can employ github.com/swaggest/rest to build a self-documenting HTTP REST API. This library establishes a convention to declare handlers in a way that can be used to reflect documentation and schema and maintain a single source of truth about it.

In my personal opinion code first approach has advantages comparing to spec first approach. It can lower the entry bar by not requiring to be an expert in spec language syntax. And it may help to come up with a spec that is well balanced with implementation details.

With code first approach it is not necessary to implement a full service to get the spec. You only need to define the structures and interfaces and may postpone actual logic implementation.

Please check a brief usage example.

Although i dont know much about Flask, usually you could something like this:

The problem is that AWS API Gateway expects swagger/OpenAPI version 3, and your file is version 2. If you only want a way to host swagger UI for documentation/collaboration purposes, take a look at SwaggerHub https://swagger.io/tools/swaggerhub/.

But, if you really have to use AWS API Gateway, then you need to get spec in OpenAPI-3 format. Since the API is rather small, I'd suggest preparing OpenAPI-3 spec yourself (rather than generating it) and testing it locally via swagger UI.

After reviewing that it was the same key being returned, I found in the code that the value inputted was being overwritten by test data I had previously introduced

bulk_insert_mappings(mapper , mappings) mappings is a sequence of dictionaries. your mappings(csv_json_response) is a sequence of list. so you should change csv_json_response. https://docs.sqlalchemy.org/en/13/orm/session_api.html#sqlalchemy.orm.session.Session.bulk_insert_mappings

I made a few mistakes in my code and test:

1. Registering api before declaring the routes.
2. Making a wierd assumption about how the arguments would be passed to the post method.
3. Using a model instead of request parser in the expect decorator
4. Calling the endpoints in my testing with an erroneous api/ prefix.

I believe it's because I registered the namespace on the api before declaring any routes.

My understanding is when the api is registered on the app, the swagger documentation and routes on the app are setup at that point. Thus any routes defined on the api after this are not recognised. I think this because when I declared the namespace in the views/test.py file (also the model to avoid circular referencing between this file and views/__init__.py), the swagger documentation had the routes defined and my tests worked (after I corrected them).

There were some more mistakes in my app and my tests, which were

In my app, in the views/test.py file, I made a silly assumption that a variable would be made of the expected parameter (that I would just magically have greeting as some non-local variable). Looking at the documentation, I learnt about the RequestParser, and that I needed to declare one like so