how to customize post method #126

hyh1618 · 2022-09-29T14:04:33Z

hyh1618
Sep 29, 2022

Can anyone please tell me how do I add actions into the generated POST action? Post will create a record into class object table, but I need do more after that. Thanks a lot!

thomaxxl · 2022-09-29T14:23:00Z

thomaxxl
Sep 29, 2022
Maintainer

You can do this by hooking HTTP POST, https://github.com/thomaxxl/safrs/wiki/HTTP-Methods . Hooking relationship post is a bit more complicated.

There are also other ways to achieve what you want, using sqlalchemy triggers for example.

3 replies

hyh1618 Sep 29, 2022
Author

Thanks a lot thomaxxl. what i need is to send the generated new record/class object to somewhere, either hooking or trigger will work, can you please point me to more details about it? as I'm new here. I tried example hooking as below but it throw error " ERROR: _s_post() missing 1 required positional argument: 'self' "
def _s_post(self, *args, **kwargs):
print(kwargs)
I appreciate much.

thomaxxl Sep 29, 2022
Maintainer

Hi,

I am on holiday atm without computer so I can't check this myself. Another approach is used here, where decorators are used to hook HTTP requests.

https://github.com/thomaxxl/safrs/blob/master/examples/authentication/demo_post_auth.py

hyh1618 Sep 29, 2022
Author

Thanks, please help when you can. I tried that decorator, seems its before the record creation, I can't get data.

thomaxxl · 2022-10-02T18:11:31Z

thomaxxl
Oct 2, 2022
Maintainer

This is one approach (using flask request and response)
https://gist.github.com/thomaxxl/7f009114b0c86b7205611a60a0704abf

can you try it please?

0 replies

thomaxxl · 2022-10-03T17:28:10Z

thomaxxl
Oct 3, 2022
Maintainer

For the record, _s_post is a bit more complicated than described in the wiki as it's a classmethod.
This should work

    @classmethod
    def _s_post(cls, *args, **kwargs):
        print(kwargs)
        result = User(*args, **kwargs)
        print(result)
        return result

I will update the documentation.

0 replies

hyh1618 · 2022-10-03T23:10:43Z

hyh1618
Oct 3, 2022
Author

Thanks Thomaxxl/Safrs, At this point (in your code) the new record already committed in DB? I need call another function from here which will need this record already in DB. Thanks!

…

On Mon, Oct 3, 2022 at 1:28 PM Thomas Pollet ***@***.***> wrote: For the record, _s_post is a bit more complicated than described in the wiki as it's a classmethod. This should work <https://gist.github.com/thomaxxl/48fbd9c0401e677a588c8048522310bd> @classmethod def _s_post(cls, *args, **kwargs): print(kwargs) result = User(*args, **kwargs) print(result) return result I will update the documentation. — Reply to this email directly, view it on GitHub <#126 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ANENUR6SY4H52M45UMUJ7ATWBMJTLANCNFSM6AAAAAAQYZ42NA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

0 replies

thomaxxl · 2022-10-04T11:31:04Z

thomaxxl
Oct 4, 2022
Maintainer

Records are automatically committed when created in SAFRSBase.__init__, unless SAFRSBase._s_auto_commit is False (default is True for now but this might change in future versions).

0 replies

hyh1618 · 2022-10-11T09:18:08Z

hyh1618
Oct 11, 2022
Author

Hi Thomaxxl/Safrs, Thanks. Yes it committed and can be queried, but it throw exception and exit at end: Error: 'NoneType' object has no attribute '_s_object_id' I'm on Python 3.9 and latest safrs

…

On Tue, Oct 4, 2022, 7:31 AM Thomas Pollet ***@***.***> wrote: Records are automatically committed when created in SAFRSBase.__init__, unless SAFRSBase._s_auto_commit is False (default is True for now but this might change in future versions). — Reply to this email directly, view it on GitHub <#126 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ANENUR6HISQRPYELEOUXC6LWBQIQFANCNFSM6AAAAAAQYZ42NA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

1 reply

thomaxxl Oct 11, 2022
Maintainer

I think you forgot to return the created class ( return result)

see https://gist.github.com/thomaxxl/48fbd9c0401e677a588c8048522310bd

hyh1618 · 2022-10-20T16:55:56Z

hyh1618
Oct 20, 2022
Author

Thanks Thomas, it is working now. Can you please show me an example to display description info for a column? It seems not works for 2.12.3. the table description works. Thanks a lot for your help.

…

On Tue, Oct 11, 2022, 5:29 AM Thomas Pollet ***@***.***> wrote: I think you forgot to return the created class ( return result) see https://gist.github.com/thomaxxl/48fbd9c0401e677a588c8048522310bd — Reply to this email directly, view it on GitHub <#126 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ANENUR2JLE5TQUVHYFKEBQLWCUXPPANCNFSM6AAAAAAQYZ42NA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

1 reply

thomaxxl Oct 20, 2022
Maintainer

You want to change the description shown in the swagger?

You can modify the spec by providing the custom_swagger argument to SAFRSAPI:

safrs/examples/mini_examples/ex12_swagger.py

Line 53 in b411752

    
           api = SAFRSAPI(app, host=host, port=port, prefix=api_prefix, custom_swagger=custom_swagger)

hyh1618 · 2022-10-20T17:22:12Z

hyh1618
Oct 20, 2022
Author

Yes. I mean to customize the default service, such as get or post, to add description such as "use yyy-mm-dd" as format for field created, like that. Thanks!

…

On Thu, Oct 20, 2022, 1:14 PM Thomas Pollet ***@***.***> wrote: You want to change the description shown in the swagger? You can modify the spec by providing the custom_swagger argument to SAFRSAPI: https://github.com/thomaxxl/safrs/blob/b411752adb9cc7af2828fa4ccefe89fb6cd469b4/examples/mini_examples/ex12_swagger.py#L53 — Reply to this email directly, view it on GitHub <#126 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ANENUR7LWUXWOZ27J3AL6R3WEF4ZBANCNFSM6AAAAAAQYZ42NA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

1 reply

thomaxxl Oct 20, 2022
Maintainer

The only way to do this is by modifying the swagger manually. You can import and edit the spec with https://editor.swagger.io/ , then host the spec and swagger ui elsewhere, or merge using the above custom_swagger argument.

hyh1618 · 2022-10-20T18:22:15Z

hyh1618
Oct 20, 2022
Author

Thanks, is it possible to send a example of custom_swagger argument for service level description?

…

On Thu, Oct 20, 2022, 1:42 PM Thomas Pollet ***@***.***> wrote: The only way to do this is by modifying the swagger manually. You can import and edit the spec with https://editor.swagger.io/ , then host the spec and swagger ui elsewhere, or merge using the above custom_swagger argument. — Reply to this email directly, view it on GitHub <#126 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ANENUR66CR7VSV2JANY4URDWEGAAJANCNFSM6AAAAAAQYZ42NA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

0 replies

hyh1618 · 2022-10-21T14:55:59Z

hyh1618
Oct 21, 2022
Author

Hi Thomas, On another topic, I see your demo_auth.py, run it, the page does not pop up to ask userid/pw, how do you suggest to let user type in userid & password in UI? Thanks a lot.

…

On Thu, Oct 20, 2022 at 2:22 PM Jonathan Huang ***@***.***> wrote: Thanks, is it possible to send a example of custom_swagger argument for service level description? On Thu, Oct 20, 2022, 1:42 PM Thomas Pollet ***@***.***> wrote: > The only way to do this is by modifying the swagger manually. You can > import and edit the spec with https://editor.swagger.io/ , then host the > spec and swagger ui elsewhere, or merge using the above custom_swagger > argument. > > — > Reply to this email directly, view it on GitHub > <#126 (reply in thread)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/ANENUR66CR7VSV2JANY4URDWEGAAJANCNFSM6AAAAAAQYZ42NA> > . > You are receiving this because you authored the thread.Message ID: > ***@***.***> >

1 reply

thomaxxl Oct 22, 2022
Maintainer

Hi,

Can you next time open a new discussion thread for new questions please?

API authentication is usually implemented using a token passed in the HTTP Authorization header.
You should add this header when you execute HTTP requests in the frontend, so this depends a bit on which frontend you use.

Regarding the swagger, this will require some work if you want to customize it. The custom_swagger argument will merge the given items with the existing swagger. So, you'll have to find out which items you want to modify, then pass this as a dictionary to custom_swagger.

hyh1618 · 2022-10-22T14:30:14Z

hyh1618
Oct 22, 2022
Author

OK, I will. Yes I know to add an item into custom_swagger dict, but I don't know the naming pattern for a service endpoint, is it classname_fieldname? any doc link on this? Thanks.

…

On Sat, Oct 22, 2022 at 8:04 AM Thomas Pollet ***@***.***> wrote: Hi, Can you next time open a new discussion thread for new questions please? API authentication is usually implemented using a token passed in the HTTP Authorization header <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization>. You should add this header when you execute HTTP requests in the frontend, so this depends a bit on which frontend you use. Regarding the swagger, this will require some work if you want to customize it. The custom_swagger argument will merge the given items with the existing swagger. So, you'll have to find out which items you want to modify, then pass this as a dictionary to custom_swagger. — Reply to this email directly, view it on GitHub <#126 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ANENURZYTZFIGER4U7KI2C3WEPJ5RANCNFSM6AAAAAAQYZ42NA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

how to customize post method #126

{{title}}

Replies: 11 comments 7 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

how to customize post method #126

hyh1618 Sep 29, 2022

Replies: 11 comments · 7 replies

thomaxxl Sep 29, 2022 Maintainer

hyh1618 Sep 29, 2022 Author

thomaxxl Sep 29, 2022 Maintainer

hyh1618 Sep 29, 2022 Author

thomaxxl Oct 2, 2022 Maintainer

thomaxxl Oct 3, 2022 Maintainer

hyh1618 Oct 3, 2022 Author

thomaxxl Oct 4, 2022 Maintainer

hyh1618 Oct 11, 2022 Author

thomaxxl Oct 11, 2022 Maintainer

hyh1618 Oct 20, 2022 Author

thomaxxl Oct 20, 2022 Maintainer

hyh1618 Oct 20, 2022 Author

thomaxxl Oct 20, 2022 Maintainer

hyh1618 Oct 20, 2022 Author

hyh1618 Oct 21, 2022 Author

thomaxxl Oct 22, 2022 Maintainer

hyh1618 Oct 22, 2022 Author

hyh1618
Sep 29, 2022

Replies: 11 comments 7 replies

thomaxxl
Sep 29, 2022
Maintainer

hyh1618 Sep 29, 2022
Author

thomaxxl Sep 29, 2022
Maintainer

hyh1618 Sep 29, 2022
Author

thomaxxl
Oct 2, 2022
Maintainer

thomaxxl
Oct 3, 2022
Maintainer

hyh1618
Oct 3, 2022
Author

thomaxxl
Oct 4, 2022
Maintainer

hyh1618
Oct 11, 2022
Author

thomaxxl Oct 11, 2022
Maintainer

hyh1618
Oct 20, 2022
Author

thomaxxl Oct 20, 2022
Maintainer

hyh1618
Oct 20, 2022
Author

thomaxxl Oct 20, 2022
Maintainer

hyh1618
Oct 20, 2022
Author

hyh1618
Oct 21, 2022
Author

thomaxxl Oct 22, 2022
Maintainer

hyh1618
Oct 22, 2022
Author