Skip to content

Feature Request: Add Example for Multiple Authentication Methods in Protobuf #50

@tavigaussboy9

Description

@tavigaussboy9

Overview

The current README provides a concise example of a UserService using a single authentication method (EmailAuth). However, developers might benefit from seeing an example that showcases how to handle multiple authentication methods together within the same service.

Suggested Enhancements

  1. Add a detailed example of multiple authentication methods: It would be helpful to provide a comprehensive example of how to implement the oneof field (auth_method in the example) for both EmailAuth and TokenAuth. This can help users understand how to structure their service for various authentication methods effectively.

  2. Documentation on handling the oneof field in generated code: Including a section explaining how the generated code behaves with the oneof field would benefit users who might be unfamiliar with the implications of using this feature.

Benefits

Adding a more elaborate example involving multiple authentication methods could help users implement more complex user authentication scenarios in their APIs, enhancing the utility of the sebuf tool.


This could significantly improve the documentation and user experience for new developers working with the project.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationpolishDocumentation, examples, test coveragev1.0Targeted for v1.0 release

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions