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
-
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.
-
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.
Overview
The current README provides a concise example of a
UserServiceusing 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
Add a detailed example of multiple authentication methods: It would be helpful to provide a comprehensive example of how to implement the
oneoffield (auth_methodin the example) for bothEmailAuthandTokenAuth. This can help users understand how to structure their service for various authentication methods effectively.Documentation on handling the oneof field in generated code: Including a section explaining how the generated code behaves with the
oneoffield 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
sebuftool.This could significantly improve the documentation and user experience for new developers working with the project.