chore(kuma-cp) add customizable API #1174
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nickolaev
force-pushed
the
chore/customizable_api
branch
from
fe74d81
to
9372ccf
Compare
added 2 commits
November 20, 2020 19:56
Signed-off-by: Nikolay Nikolaev <nikolay.nikolaev@konghq.com>
Signed-off-by: Nikolay Nikolaev <nikolay.nikolaev@konghq.com>
nickolaev
force-pushed
the
chore/customizable_api
branch
from
9372ccf
to
47930eb
Compare
Signed-off-by: Nikolay Nikolaev <nikolay.nikolaev@konghq.com>
nickolaev
force-pushed
the
chore/customizable_api
branch
from
47930eb
to
70b2578
Compare
| ws := new(restful.WebService).Path(path) | ||
| ws.Route(ws.GET(subpath).To(handler)) | ||
| c.Add(ws) | ||
| } |
There was a problem hiding this comment.
What will happen if you need something like Auth on this endpoint or filter of logging requests or add an extra method to this webservice?
I think I'd drop this method and do these 3 lines on the APIManager client that will just use Add. That's not really extensible API, you cannot add filters, change the method, add many methods to ws, add OpenAPI docs etc.
|
|
||
| apiServer := createTestApiServer(resourceStore, cfg, true, metrics, wsManager) | ||
|
|
||
| stop := make(chan struct{}) |
There was a problem hiding this comment.
close the channel
| return apiServer | ||
| } | ||
|
|
||
| var SampleTrafficRouteWsDefinition = definitions.ResourceWsDefinition{ |
There was a problem hiding this comment.
I don't think we need this for a test
pkg/api-server/server.go
Outdated
| @@ -71,7 +73,8 @@ func init() { | |||
| } | |||
| } | |||
|
|
|||
| func NewApiServer(resManager manager.ResourceManager, defs []definitions.ResourceWsDefinition, cfg *kuma_cp.Config, enableGUI bool, metrics metrics.Metrics) (*ApiServer, error) { | |||
| func NewApiServer(resManager manager.ResourceManager, wsManager customization.APIInstaller, | |||
| defs []definitions.ResourceWsDefinition, cfg *kuma_cp.Config, enableGUI bool, metrics metrics.Metrics) (*ApiServer, error) { | |||
There was a problem hiding this comment.
formatting nit. For me, it's easier to read arguments grouped in one line or every in it's own line so either
func NewApiServer(resManager manager.ResourceManager, wsManager customization.APIInstaller, defs []definitions.ResourceWsDefinition, cfg *kuma_cp.Config, enableGUI bool, metrics metrics.Metrics) (*ApiServer, error) {
or
func NewApiServer(
resManager manager.ResourceManager,
wsManager customization.APIInstaller,
defs []definitions.ResourceWsDefinition,
cfg *kuma_cp.Config,
enableGUI bool,
metrics metrics.Metrics,
) (*ApiServer, error) {
pkg/api-server/server.go
Outdated
| @@ -135,6 +138,10 @@ func NewApiServer(resManager manager.ResourceManager, defs []definitions.Resourc | |||
| } else { | |||
| container.ServeMux.HandleFunc("/gui/", newApiServer.notAvailableHandler) | |||
| } | |||
|
|
|||
| // Install the custom WS | |||
There was a problem hiding this comment.
nit: I don't think this comment is needed. I like commenting out code for the following reasons
- explaining why something is happening
- explaining code design and design decisions / tradeoffs
- explaining difficult code when language is crippling the developer to write an easy to understand code
Here it's pretty obvious what is going on
|
it's |
nickolaev
changed the title
added 2 commits
November 23, 2020 12:51
Signed-off-by: Nikolay Nikolaev <nikolay.nikolaev@konghq.com>
jakubdyszkiewicz
approved these changes
Nov 23, 2020
mergify bot
pushed a commit
that referenced
this pull request
Nov 23, 2020
* chore(*) add customizable API * chore(*) move to APIManager * chore(*) introduce APIManagaer, bootstrapBefore and After Signed-off-by: Nikolay Nikolaev <nikolay.nikolaev@konghq.com> (cherry picked from commit 598dedd)
nickolaev
pushed a commit
that referenced
this pull request
Nov 23, 2020
* chore(*) add customizable API * chore(*) move to APIManager * chore(*) introduce APIManagaer, bootstrapBefore and After Signed-off-by: Nikolay Nikolaev <nikolay.nikolaev@konghq.com> (cherry picked from commit 598dedd) Co-authored-by: Nikolay Nikolaev <nikolay.nikolaev@konghq.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adding customizable API.
Documentation