DM-43939: Create a bootcamp demo app showing basic path operations #2
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
For this "external" router, we'll use it to demonstrate basic path operations, and keeping the models co-located with the path operation functions makes it a little easier to demonstrate. By getting rid of the models module, we also make space for a better architecture for separating internal and API models.
I think this was a bug in our template that'll be fixed in lsst/templates#253
Cover path parameters, query parameters, response models, and post requests with request models. Cover basic logging with Safir's logger_dependency.
jonathansick
force-pushed
the
tickets/DM-43939
branch
from
97d75c0 to
cdcedd8
Compare
We'll need to modify the template to deal with hyphenated app names.
jonathansick
force-pushed
the
tickets/DM-43939
branch
from
cdcedd8 to
9f284da
Compare
rra
approved these changes
Apr 26, 2024
| @@ -27,7 +27,7 @@ class Config(BaseSettings): | |||
| ) | |||
|
|
|||
| model_config = SettingsConfigDict( | |||
| env_prefix="FASTAPI-BOOTCAMP_", case_sensitive=False | |||
| env_prefix="FASTAPI_BOOTCAMP_", case_sensitive=False | |||
Comment on lines
81
to
87
| # ============================================================================= | ||
| # Lesson 1: A simple GET endpoint. | ||
|
|
||
|
|
||
| @external_router.get("/hello", summary="Get a friendly greeting.") | ||
| async def get_greeting() -> str: | ||
| return "Hello, SQuaRE Services Bootcamp!" |
There was a problem hiding this comment.
I think I agree with keeping this simple, but it could be a bit surprising that this handler still returns JSON, so the response will have quote marks around it. The simplest response from an HTTP perspective would require a bit more complexity in FastAPI to specify response_class=PlainTextResponse. Maybe that's worth mentioning in a comment?
There was a problem hiding this comment.
I didn't think about that, but mentioning this will definitely clarify things.
Rather than mixing JSON and query parameters in the same example, let's do the JSON response first, and then add in the query parameter next.
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.
Covers path parameters, query parameters, response models, and post requests with request models. Cover basic logging with Safir's logger_dependency.
In the next PR, #3, we add to this with a realistic app to show the sqr-072.lsst.io-type architecture.