Add API Key based auth #770
Conversation
Server Mode에서 API 키 기반 인증 기능을 추가합니다. - `cmd/server.go`: `--api-key` 플래그 추가 및 옵션 전달 - `pkg/model/options.go`: `APIKey`, `ServerType` 필드 추가 - `pkg/server/server.go`: API 키 인증 미들웨어 추가 (REST API 타입에만 적용) - `docs/page/modes/server-mode.md`: API 키 사용 방법 문서 업데이트
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @hahwul, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces API key-based authentication for the server mode, specifically targeting the REST API. This enhancement allows users to secure their Dalfox server instances by requiring a valid API key for incoming requests, improving the overall security posture of the server.
Highlights
- API Key Command-Line Flag: A new
--api-keyflag has been added to thedalfox servercommand, allowing users to specify a secret key for authentication when starting the server. - Server Options Update: The core
Optionsstruct (pkg/model/options.go) now includesAPIKeyandServerTypefields to properly configure and pass authentication settings. - REST API Authentication Middleware: An API key authentication middleware has been implemented for the REST API server. When an API key is configured, all incoming requests to the REST API will be validated against this key, rejecting unauthorized access.
- Comprehensive Documentation: The server mode documentation (
docs/page/modes/server-mode.md) has been updated to include instructions on how to use the new--api-keyflag and how to include theX-API-KEYheader incurlrequests.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Codecov ReportAttention: Patch coverage is
📢 Thoughts on this report? Let us know! |
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Server Mode에서 API 키 기반 인증 기능을 추가합니다.
cmd/server.go:--api-key플래그 추가 및 옵션 전달pkg/model/options.go:APIKey,ServerType필드 추가pkg/server/server.go: API 키 인증 미들웨어 추가 (REST API 타입에만 적용)docs/page/modes/server-mode.md: API 키 사용 방법 문서 업데이트